io.alauda.kubernetes.client.dsl.base

Class BaseOperation<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,D extends io.alauda.kubernetes.api.model.Doneable<T>,R extends Resource<T,D>>

java.lang.Object

io.alauda.kubernetes.client.dsl.base.OperationSupport

io.alauda.kubernetes.client.dsl.base.BaseOperation<T,L,D,R>

All Implemented Interfaces:

AnyNamespaceable<FilterWatchListMultiDeletable<T,L,Boolean,Watch,Watcher<T>>>, Cascading<EditReplacePatchDeletable<T,T,D,Boolean>>, CascadingEditReplacePatchDeletable<T,T,D,Boolean>, Createable<T,T,D>, CreateFromServerGettable<T,T,D>, CreateOrReplaceable<T,T,D>, Deletable<Boolean>, Editable<D>, EditReplacePatchable<T,T,D>, EditReplacePatchDeletable<T,T,D,Boolean>, Filterable<FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>>, FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>, FilterWatchListMultiDeletable<T,L,Boolean,Watch,Watcher<T>>, FromServerable<Gettable<T>>, Gettable<T>, Listable<L>, Loadable<R>, Lockable<Replaceable<T,T>>, MixedOperation<T,L,D,R>, MultiDeleteable<T,Boolean>, Nameable<R>, Namespaceable<NonNamespaceOperation<T,L,D,R>>, NonNamespaceOperation<T,L,D,R>, Operation<T,L,D,R>, Patchable<T,T>, Readiable, Replaceable<T,T>, Resource<T,D>, Versionable<Watchable<Watch,Watcher<T>>>, VersionWatchable<Watch,Watcher<T>>, Waitable<T>, Watchable<Watch,Watcher<T>>, WatchListDeletable<T,L,Boolean,Watch,Watcher<T>>, FromServerGettable<T>, GracePeriodConfigurable<Deletable<Boolean>>, OperationInfo

Direct Known Subclasses:

HasMetadataOperation

public class BaseOperation<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,D extends io.alauda.kubernetes.api.model.Doneable<T>,R extends Resource<T,D>>
extends OperationSupport
implements OperationInfo, MixedOperation<T,L,D,R>, Resource<T,D>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiGroupVersion
protected Reaper	reaper

Fields inherited from class io.alauda.kubernetes.client.dsl.base.OperationSupport

apiGroup, apiVersion, client, config, JSON, JSON_MAPPER, JSON_PATCH, name, namespace, resourceT, YAML_MAPPER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseOperation(okhttp3.OkHttpClient client, Config config, String apiGroup, String apiVersion, String resourceT, String namespace, String name, Boolean cascading, T item, String resourceVersion, Boolean reloadingFromServer, Class<T> type, Class<L> listType, Class<D> doneableType)
protected	BaseOperation(okhttp3.OkHttpClient client, Config config, String apiGroup, String apiVersion, String resourceT, String namespace, String name, Boolean cascading, T item, String resourceVersion, Boolean reloadingFromServer, long gracePeriodSeconds, Map<String,String> labels, Map<String,String> labelsNot, Map<String,String[]> labelsIn, Map<String,String[]> labelsNotIn, Map<String,String> fields)

Method Summary

Modifier and Type	Method and Description
EditReplacePatchDeletable<T,T,D,Boolean>	cascading(boolean cascading)
T	create(T... resources)
protected R	createItemOperation(T item)
D	createNew()
T	createOrReplace(T... items)
D	createOrReplaceWithNew()
Boolean	delete() Deletes resource & all managed resources, returns null or false if not found.
Boolean	delete(List<T> items)
Boolean	delete(T... items)
D	edit()
OperationInfo	forOperationType(String type)
Gettable<T>	fromServer()
T	get()
String	getApiGroupVersion()
protected Class<? extends Config>	getConfigType()
Class<D>	getDoneableType()
String	getFieldQueryParam()
protected Map<String,String>	getFields()
Long	getGracePeriodSeconds()
T	getItem()
String	getKind()
String	getLabelQueryParam()
protected Map<String,String>	getLabels()
protected Map<String,String[]>	getLabelsIn()
protected Map<String,String>	getLabelsNot()
protected Map<String,String[]>	getLabelsNotIn()
Class<L>	getListType()
T	getMandatory()
String	getOperationType()
Boolean	getReloadingFromServer() Deprecated.
String	getResourceT()
String	getResourceVersion()
io.alauda.kubernetes.api.model.RootPaths	getRootPaths()
Class<T>	getType()
protected T	handleCreate(T resource)
protected T	handleGet(URL resourceUrl)
protected T	handlePatch(T current, T updated)
protected T	handleReplace(T updated)
protected T	handleResponse(okhttp3.Request.Builder requestBuilder)
NonNamespaceOperation<T,L,D,R>	inAnyNamespace()
NonNamespaceOperation<T,L,D,R>	inNamespace(String namespace)
boolean	isApiGroup() Return true if this is an API Group where the versions include a slash in them
Boolean	isCascading()
Boolean	isReady()
protected boolean	isReaping()
Boolean	isReloadingFromServer()
boolean	isResourceNamespaced()
L	list()
R	load(File file) Load from a File.
R	load(InputStream is) Load from an InputStream.
R	load(String path) Load from path.
R	load(URL url) Load from a URL.
Replaceable<T,T>	lockResourceVersion(String resourceVersion)
T	patch(T item)
T	replace(T item)
protected void	setReaping(boolean reaping)
protected void	updateApiVersion(io.alauda.kubernetes.api.model.HasMetadata hasMetadata) Updates the resource if it has missing or default apiVersion values and the resource is currently using API Groups with custom version strings
protected void	updateApiVersion(io.alauda.kubernetes.api.model.KubernetesResourceList list) Updates the list items if they have missing or default apiVersion values and the resource is currently using API Groups with custom version strings
protected void	updateApiVersionResource(Object resource) Updates the list or single item if it has a missing or incorrect apiVersion
protected T	waitUntilExists(long timeoutInMillis)
T	waitUntilReady(long amount, TimeUnit timeUnit)
Watch	watch(String resourceVersion, Watcher<T> watcher)
Watch	watch(Watcher<T> watcher)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withField(String key, String value)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withFields(Map<String,String> labels)
Deletable<Boolean>	withGracePeriod(long gracePeriodSeconds)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withLabel(String key)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withLabel(String key, String value)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withLabelIn(String key, String... values)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withLabelNotIn(String key, String... values)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withLabels(Map<String,String> labels)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withLabelSelector(io.alauda.kubernetes.api.model.LabelSelector selector)
R	withName(String name)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withoutLabel(String key)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withoutLabel(String key, String value)
FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>>	withoutLabels(Map<String,String> labels)
Watchable<Watch,Watcher<T>>	withResourceVersion(String resourceVersion)

Methods inherited from class io.alauda.kubernetes.client.dsl.base.OperationSupport

assertResponseCode, checkName, checkNamespace, createStatus, createStatus, getAPIGroup, getAPIVersion, getConfig, getName, getNamespace, getNamespacedUrl, getNamespacedUrl, getNamespacedUrl, getResourceUrl, getResourceUrl, getRootUrl, handleCreate, handleDelete, handleDelete, handleGet, handleGet, handlePatch, handleReplace, handleReplace, handleResponse, handleResponse, handleResponse, handleResponse, requestException, requestFailure, unmarshal, unmarshal, unmarshal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.alauda.kubernetes.client.OperationInfo

getName, getNamespace

Field Detail

reaper

protected Reaper reaper

apiGroupVersion

protected String apiGroupVersion

Constructor Detail

BaseOperation

protected BaseOperation(okhttp3.OkHttpClient client,
                        Config config,
                        String apiGroup,
                        String apiVersion,
                        String resourceT,
                        String namespace,
                        String name,
                        Boolean cascading,
                        T item,
                        String resourceVersion,
                        Boolean reloadingFromServer,
                        long gracePeriodSeconds,
                        Map<String,String> labels,
                        Map<String,String> labelsNot,
                        Map<String,String[]> labelsIn,
                        Map<String,String[]> labelsNotIn,
                        Map<String,String> fields)

BaseOperation

protected BaseOperation(okhttp3.OkHttpClient client,
                        Config config,
                        String apiGroup,
                        String apiVersion,
                        String resourceT,
                        String namespace,
                        String name,
                        Boolean cascading,
                        T item,
                        String resourceVersion,
                        Boolean reloadingFromServer,
                        Class<T> type,
                        Class<L> listType,
                        Class<D> doneableType)

Method Detail

get

public T get()

Specified by:

get in interface Gettable<T>

Returns:

the item or null if the item doesn't exist.

getMandatory

public T getMandatory()

getRootPaths

public io.alauda.kubernetes.api.model.RootPaths getRootPaths()

edit

public D edit()
       throws KubernetesClientException

Specified by:

edit in interface Editable<D extends io.alauda.kubernetes.api.model.Doneable<T>>

Throws:

KubernetesClientException

withName

public R withName(String name)

Specified by:

withName in interface Nameable<R extends Resource<T,D>>

lockResourceVersion

public Replaceable<T,T> lockResourceVersion(String resourceVersion)

Specified by:

lockResourceVersion in interface Lockable<Replaceable<T,T>>

inNamespace

public NonNamespaceOperation<T,L,D,R> inNamespace(String namespace)

Specified by:

inNamespace in interface Namespaceable<NonNamespaceOperation<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,D extends io.alauda.kubernetes.api.model.Doneable<T>,R extends Resource<T,D>>>

inAnyNamespace

public NonNamespaceOperation<T,L,D,R> inAnyNamespace()

Specified by:

inAnyNamespace in interface AnyNamespaceable<FilterWatchListMultiDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

cascading

public EditReplacePatchDeletable<T,T,D,Boolean> cascading(boolean cascading)

Specified by:

cascading in interface Cascading<EditReplacePatchDeletable<T,T,D extends io.alauda.kubernetes.api.model.Doneable<T>,Boolean>>

load

public R load(InputStream is)

Description copied from interface: Loadable

Load from an InputStream.

Specified by:

load in interface Loadable<R extends Resource<T,D>>

Parameters:

is - The input stream.

Returns:

load

public R load(URL url)

Description copied from interface: Loadable

Load from a URL.

Specified by:

load in interface Loadable<R extends Resource<T,D>>

Parameters:

url - The url.

Returns:

load

public R load(File file)

Description copied from interface: Loadable

Load from a File.

Specified by:

load in interface Loadable<R extends Resource<T,D>>

Parameters:

file - The file.

Returns:

load

public R load(String path)

Description copied from interface: Loadable

Load from path.

Specified by:

load in interface Loadable<R extends Resource<T,D>>

Parameters:

path - The path.

Returns:

fromServer

public Gettable<T> fromServer()

Specified by:

fromServer in interface FromServerable<Gettable<T>>

create

public T create(T... resources)
         throws KubernetesClientException

Specified by:

create in interface Createable<T,T,D extends io.alauda.kubernetes.api.model.Doneable<T>>

Throws:

KubernetesClientException

createNew

public D createNew()
            throws KubernetesClientException

Specified by:

createNew in interface Createable<T,T,D extends io.alauda.kubernetes.api.model.Doneable<T>>

Throws:

KubernetesClientException

createOrReplaceWithNew

public D createOrReplaceWithNew()
                         throws KubernetesClientException

Specified by:

createOrReplaceWithNew in interface CreateOrReplaceable<T,T,D extends io.alauda.kubernetes.api.model.Doneable<T>>

Throws:

KubernetesClientException

createOrReplace

public T createOrReplace(T... items)

Specified by:

createOrReplace in interface CreateOrReplaceable<T,T,D extends io.alauda.kubernetes.api.model.Doneable<T>>

withLabels

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withLabels(Map<String,String> labels)

Specified by:

withLabels in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

withLabelSelector

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withLabelSelector(io.alauda.kubernetes.api.model.LabelSelector selector)

Specified by:

withLabelSelector in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

withoutLabels

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withoutLabels(Map<String,String> labels)
                                                                     throws KubernetesClientException

Specified by:

withoutLabels in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

Throws:

KubernetesClientException

withLabelIn

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withLabelIn(String key,
                                                                          String... values)
                                                                   throws KubernetesClientException

Specified by:

withLabelIn in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

Throws:

KubernetesClientException

withLabelNotIn

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withLabelNotIn(String key,
                                                                             String... values)
                                                                      throws KubernetesClientException

Specified by:

withLabelNotIn in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

Throws:

KubernetesClientException

withLabel

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withLabel(String key,
                                                                        String value)

Specified by:

withLabel in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

withLabel

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withLabel(String key)

Specified by:

withLabel in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

withoutLabel

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withoutLabel(String key,
                                                                           String value)

Specified by:

withoutLabel in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

withoutLabel

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withoutLabel(String key)

Specified by:

withoutLabel in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

withFields

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withFields(Map<String,String> labels)

Specified by:

withFields in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

withField

public FilterWatchListDeletable<T,L,Boolean,Watch,Watcher<T>> withField(String key,
                                                                        String value)

Specified by:

withField in interface Filterable<FilterWatchListDeletable<T,L extends io.alauda.kubernetes.api.model.KubernetesResourceList,Boolean,Watch,Watcher<T>>>

getLabelQueryParam

public String getLabelQueryParam()

getFieldQueryParam

public String getFieldQueryParam()

list

public L list()
       throws KubernetesClientException

Specified by:

list in interface Listable<L extends io.alauda.kubernetes.api.model.KubernetesResourceList>

Throws:

KubernetesClientException

delete

public Boolean delete()

Description copied from interface: Deletable

Deletes resource & all managed resources, returns null or false if not found.

Specified by:

delete in interface Deletable<Boolean>

delete

public Boolean delete(T... items)

Specified by:

delete in interface MultiDeleteable<T,Boolean>

delete

public Boolean delete(List<T> items)

Specified by:

delete in interface MultiDeleteable<T,Boolean>

createItemOperation

protected R createItemOperation(T item)
                         throws InstantiationException,
                                IllegalAccessException,
                                InvocationTargetException,
                                NoSuchMethodException

Throws:

InstantiationException

IllegalAccessException

InvocationTargetException

NoSuchMethodException

withResourceVersion

public Watchable<Watch,Watcher<T>> withResourceVersion(String resourceVersion)

Specified by:

withResourceVersion in interface Versionable<Watchable<Watch,Watcher<T>>>

watch

public Watch watch(Watcher<T> watcher)
            throws KubernetesClientException

Specified by:

watch in interface Watchable<Watch,Watcher<T>>

Throws:

KubernetesClientException

watch

public Watch watch(String resourceVersion,
                   Watcher<T> watcher)
            throws KubernetesClientException

Specified by:

watch in interface Watchable<Watch,Watcher<T>>

Throws:

KubernetesClientException

replace

public T replace(T item)

Specified by:

replace in interface Replaceable<T,T>

patch

public T patch(T item)

Specified by:

patch in interface Patchable<T,T>

isResourceNamespaced

public boolean isResourceNamespaced()

Overrides:

isResourceNamespaced in class OperationSupport

handleResponse

protected T handleResponse(okhttp3.Request.Builder requestBuilder)
                    throws ExecutionException,
                           InterruptedException,
                           KubernetesClientException,
                           IOException

Throws:

ExecutionException

InterruptedException

KubernetesClientException

IOException

handleCreate

protected T handleCreate(T resource)
                  throws ExecutionException,
                         InterruptedException,
                         KubernetesClientException,
                         IOException

Throws:

ExecutionException

InterruptedException

KubernetesClientException

IOException

handleReplace

protected T handleReplace(T updated)
                   throws ExecutionException,
                          InterruptedException,
                          KubernetesClientException,
                          IOException

Throws:

ExecutionException

InterruptedException

KubernetesClientException

IOException

handlePatch

protected T handlePatch(T current,
                        T updated)
                 throws ExecutionException,
                        InterruptedException,
                        KubernetesClientException,
                        IOException

Throws:

ExecutionException

InterruptedException

KubernetesClientException

IOException

handleGet

protected T handleGet(URL resourceUrl)
               throws InterruptedException,
                      ExecutionException,
                      IOException

Throws:

InterruptedException

ExecutionException

IOException

isCascading

public Boolean isCascading()

getItem

public T getItem()

getResourceVersion

public String getResourceVersion()

getReloadingFromServer

@Deprecated
public Boolean getReloadingFromServer()

Deprecated.

isReloadingFromServer

public Boolean isReloadingFromServer()

getGracePeriodSeconds

public Long getGracePeriodSeconds()

getResourceT

public String getResourceT()

Overrides:

getResourceT in class OperationSupport

getType

public Class<T> getType()

getListType

public Class<L> getListType()

getDoneableType

public Class<D> getDoneableType()

isReaping

protected boolean isReaping()

setReaping

protected void setReaping(boolean reaping)

getLabels

protected Map<String,String> getLabels()

getLabelsNot

protected Map<String,String> getLabelsNot()

getLabelsIn

protected Map<String,String[]> getLabelsIn()

getLabelsNotIn

protected Map<String,String[]> getLabelsNotIn()

getFields

protected Map<String,String> getFields()

getKind

public String getKind()

Specified by:

getKind in interface OperationInfo

getOperationType

public String getOperationType()

Specified by:

getOperationType in interface OperationInfo

forOperationType

public OperationInfo forOperationType(String type)

Specified by:

forOperationType in interface OperationInfo

withGracePeriod

public Deletable<Boolean> withGracePeriod(long gracePeriodSeconds)

Specified by:

withGracePeriod in interface GracePeriodConfigurable<Deletable<Boolean>>

getConfigType

protected Class<? extends Config> getConfigType()

updateApiVersionResource

protected void updateApiVersionResource(Object resource)

Updates the list or single item if it has a missing or incorrect apiVersion

updateApiVersion

protected void updateApiVersion(io.alauda.kubernetes.api.model.KubernetesResourceList list)

Updates the list items if they have missing or default apiVersion values and the resource is currently using API Groups with custom version strings

updateApiVersion

protected void updateApiVersion(io.alauda.kubernetes.api.model.HasMetadata hasMetadata)

Updates the resource if it has missing or default apiVersion values and the resource is currently using API Groups with custom version strings

getApiGroupVersion

public String getApiGroupVersion()

isApiGroup

public boolean isApiGroup()

Return true if this is an API Group where the versions include a slash in them

isReady

public Boolean isReady()

Specified by:

isReady in interface Readiable

waitUntilExists

protected T waitUntilExists(long timeoutInMillis)
                     throws InterruptedException

Throws:

InterruptedException

waitUntilReady

public T waitUntilReady(long amount,
                        TimeUnit timeUnit)
                 throws InterruptedException

Specified by:

waitUntilReady in interface Waitable<T>

Throws:

InterruptedException