io.fabric8.kubernetes.client.dsl.base

Class BaseOperation<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>,R extends Resource<T>>

java.lang.Object

io.fabric8.kubernetes.client.dsl.base.OperationSupport

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

All Implemented Interfaces:

AnyNamespaceable<FilterWatchListMultiDeletable<T,L>>, Cascading<EditReplacePatchDeletable<T>>, CascadingEditReplacePatchDeletable<T>, Createable<T>, CreateFromServerGettable<T>, CreateOrReplaceable<T>, Deletable, DryRunable<WritableOperation<T>>, Editable<T>, EditReplacePatchable<T>, EditReplacePatchDeletable<T>, Filterable<FilterWatchListDeletable<T,L>>, FilterWatchListDeletable<T,L>, FilterWatchListMultiDeletable<T,L>, FromServerable<Gettable<T>>, Gettable<T>, Informable<T>, InOutCreateable<T,T>, Listable<L>, Loadable<R>, Lockable<Replaceable<T>>, MixedOperation<T,L,R>, MultiDeleteable<T>, Nameable<R>, Namespaceable<NonNamespaceOperation<T,L,R>>, NonNamespaceOperation<T,L,R>, Operation<T,L,R>, Patchable<T>, Readiable, Replaceable<T>, Requirable<T>, Resource<T>, StatusEditable<T>, StatusPatchable<T>, StatusReplaceable<T>, StatusUpdatable<T>, Versionable<WatchAndWaitable<T>>, VersionWatchAndWaitable<T>, Waitable<T,T>, Watchable<Watcher<T>>, WatchAndWaitable<T>, WatchListDeletable<T,L>, WritableOperation<T>, FromServerGettable<T>, GracePeriodConfigurable<Deletable>, OperationInfo, PropagationPolicyConfigurable<EditReplacePatchDeletable<T>>

Direct Known Subclasses:

HasMetadataOperation

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiVersion
protected Class<L>	listType
protected Class<T>	type

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

apiGroupName, apiGroupVersion, client, config, context, dryRun, JSON, JSON_MAPPER, JSON_MERGE_PATCH, JSON_PATCH, name, namespace, resourceT, STRATEGIC_MERGE_JSON_PATCH, YAML_MAPPER

Fields inherited from interface io.fabric8.kubernetes.client.dsl.Waitable

DEFAULT_BACKOFF_MULTIPLIER, DEFAULT_INITIAL_BACKOFF_MILLIS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseOperation(OperationContext ctx)

Method Summary

Modifier and Type	Method and Description
T	accept(Consumer<T> consumer) Issues a JSON patch against the item based upon the changes made by the function provided as argument
EditReplacePatchDeletable<T>	cascading(boolean cascading) deletes dependent resources.
T	create(T... resources)
T	create(T resource)
T	createOrReplace(T... items) Creates a provided resource in a Kubernetes Cluster.
Boolean	delete() Deletes resource and all managed resources, returns null or false if not found.
Boolean	delete(List<T> items)
Boolean	delete(T... items)
WritableOperation<T>	dryRun(boolean isDryRun) Indicates whether modifications should not be persisted or not.
<V> T	edit(Class<V> visitorType, io.fabric8.kubernetes.api.builder.Visitor<V> visitor) Issues a JSON patch against the item based upon the changes made to the object by the visitor.
T	edit(UnaryOperator<T> function) Issues a JSON patch against the item based upon the changes made to the object returned by the function.
T	edit(io.fabric8.kubernetes.api.builder.Visitor... visitors) Issues a JSON patch against the item based upon the changes made to the object by the visitors.
T	editStatus(UnaryOperator<T> function)
protected URL	fetchListUrl(URL url, io.fabric8.kubernetes.api.model.ListOptions listOptions)
OperationInfo	forOperationType(String type)
Gettable<T>	fromServer()
T	get()
protected Class<? extends Config>	getConfigType()
String	getFieldQueryParam()
Long	getGracePeriodSeconds()
T	getItem()
String	getKind()
String	getLabelQueryParam()
Class<L>	getListType()
T	getMandatory()
String	getOperationType()
io.fabric8.kubernetes.api.model.DeletionPropagation	getPropagationPolicy()
Readiness	getReadiness()
String	getResourceT()
String	getResourceVersion()
io.fabric8.kubernetes.api.model.RootPaths	getRootPaths()
Class<T>	getType()
protected T	handleCreate(T resource)
protected io.fabric8.kubernetes.api.model.Status	handleDeploymentRollback(io.fabric8.kubernetes.api.model.extensions.DeploymentRollback deploymentRollback)
protected T	handleGet(URL resourceUrl)
protected T	handlePatch(PatchContext context, T current, T updated, boolean status)
protected T	handlePatch(T current, Map<String,Object> patchedUpdate)
protected T	handleResponse(okhttp3.Request.Builder requestBuilder)
protected io.fabric8.kubernetes.api.model.autoscaling.v1.Scale	handleScale(io.fabric8.kubernetes.api.model.autoscaling.v1.Scale scaleParam)
protected T	handleUpdate(T updated, boolean status)
NonNamespaceOperation<T,L,R>	inAnyNamespace()
SharedIndexInformer<T>	inform(ResourceEventHandler<T> handler, long resync) Similar to a Watch, but will attempt to handle failures after successfully started.
CompletableFuture<List<T>>	informOnCondition(Predicate<List<T>> condition) Return a Future when the list at this context satisfies the given Predicate.
NonNamespaceOperation<T,L,R>	inNamespace(String namespace)
Boolean	isCascading()
boolean	isReady() Check if the resource is ready.
Boolean	isReloadingFromServer()
boolean	isResourceNamespaced()
L	list()
L	list(Integer limitVal, String continueVal) List resources from APIServer.
L	list(io.fabric8.kubernetes.api.model.ListOptions listOptions) List resource from Kubernetes API server.
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>	lockResourceVersion(String resourceVersion)
BaseOperation<T,L,R>	newInstance(OperationContext context)
T	patch(PatchContext patchContext, String patch) Update field(s) of a resource using type specified in PatchContext(defaults to strategic merge if not specified).
T	patch(PatchContext patchContext, T item) Update field(s) of a resource using type specified in PatchContext(defaults to strategic merge if not specified).
T	patchStatus(T item) Does a PATCH request to the /status subresource ignoring changes to anything except the status stanza.
T	replace(T item) Replace the server's state with the given item.
T	replaceStatus(T item) Similar to Replaceable.replace(Object), but only affects the status subresource
T	require()
protected T	sendPatchedObject(T oldObject, T updatedObject)
void	setListType(Class<L> listType)
void	setNamespace(String namespace)
void	setType(Class<T> type)
protected void	updateApiVersion(io.fabric8.kubernetes.api.model.HasMetadata hasMetadata) Updates the resource if it has missing or default apiGroupVersion values and the resource is currently using API Groups with custom version strings
protected void	updateApiVersion(io.fabric8.kubernetes.api.model.KubernetesResourceList<T> list) Updates the list items if they have missing or default apiGroupVersion values and the resource is currently using API Groups with custom version strings
T	updateStatus(T item) When the status subresource is enabled, the /status subresource for the custom resource is exposed.
T	waitUntilCondition(Predicate<T> condition, long amount, TimeUnit timeUnit)
T	waitUntilReady(long amount, TimeUnit timeUnit)
Watch	watch(io.fabric8.kubernetes.api.model.ListOptions options, Watcher<T> watcher) Watch returns Watch interface that watches requested resource
Watch	watch(String resourceVersion, Watcher<T> watcher) Watch returns Watch interface that watches requested resource from specified resourceVersion
Watch	watch(Watcher<T> watcher) Watch returns Watch interface that watches requested resource
FilterWatchListDeletable<T,L>	withField(String key, String value)
FilterWatchListDeletable<T,L>	withFields(Map<String,String> fields)
FilterWatchListDeletable<T,L>	withGracePeriod(long gracePeriodSeconds) The duration in seconds before the object should be deleted.
Informable<T>	withIndexers(Map<String,Function<T,List<String>>> indexers) The indexers to add to SharedInformers created by subsequent inform calls;
FilterWatchListDeletable<T,L>	withInvolvedObject(io.fabric8.kubernetes.api.model.ObjectReference objectReference) Filter with the object that this event is about.
BaseOperation<T,L,R>	withItem(T item)
FilterWatchListDeletable<T,L>	withLabel(String key, String value)
FilterWatchListDeletable<T,L>	withLabelIn(String key, String... values)
FilterWatchListDeletable<T,L>	withLabelNotIn(String key, String... values)
FilterWatchListDeletable<T,L>	withLabels(Map<String,String> labels)
FilterWatchListDeletable<T,L>	withLabelSelector(io.fabric8.kubernetes.api.model.LabelSelector selector)
R	withName(String name)
FilterNested<FilterWatchListDeletable<T,L>>	withNewFilter() Accumulate a filter on the context, when done FilterNested.endFilter() or and must be called
FilterWatchListDeletable<T,L>	withoutField(String key, String value)
FilterWatchListDeletable<T,L>	withoutFields(Map<String,String> fields)
FilterWatchListDeletable<T,L>	withoutLabel(String key, String value)
FilterWatchListDeletable<T,L>	withoutLabels(Map<String,String> labels)
EditReplacePatchDeletable<T>	withPropagationPolicy(io.fabric8.kubernetes.api.model.DeletionPropagation propagationPolicy) Whether and how garbage collection will be performed.
R	withResourceVersion(String resourceVersion)
BaseOperation<T,L,R>	withWaitRetryBackoff(long initialBackoff, TimeUnit backoffUnit, double backoffMultiplier) Configure the backoff strategy to use when waiting for conditions, in case the watcher encounters a retryable error.

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

assertResponseCode, checkName, checkNamespace, createStatus, createStatus, getAPIGroupName, getAPIGroupVersion, getConfig, getName, getNamespace, getNamespacedUrl, getNamespacedUrl, getNamespacedUrl, getObjectValueAsMap, getResourceUrl, getResourceUrl, getResourceUrl, getResourceURLForPatchOperation, getResourceURLForWriteOperation, getRootUrl, handleCreate, handleDelete, handleDelete, handleDeploymentRollback, handleGet, handleGet, handleMetric, handlePatch, handlePatch, handlePatch, handleResponse, handleResponse, handleResponse, handleResponse, handleScale, handleUpdate, handleUpdate, requestException, requestFailure, retryWithExponentialBackoff, 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.fabric8.kubernetes.client.OperationInfo

getName, getNamespace

Methods inherited from interface io.fabric8.kubernetes.client.dsl.Filterable

withLabel, withoutLabel

Methods inherited from interface io.fabric8.kubernetes.client.dsl.Informable

inform, inform

Methods inherited from interface io.fabric8.kubernetes.client.dsl.Patchable

patch, patch

Methods inherited from interface io.fabric8.kubernetes.client.dsl.DryRunable

dryRun

Field Detail

apiVersion

protected String apiVersion

type

protected Class<T extends io.fabric8.kubernetes.api.model.HasMetadata> type

listType

protected Class<L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>> listType

Constructor Detail

BaseOperation

protected BaseOperation(OperationContext ctx)

Method Detail

newInstance

public BaseOperation<T,L,R> newInstance(OperationContext context)

fetchListUrl

protected URL fetchListUrl(URL url,
                           io.fabric8.kubernetes.api.model.ListOptions listOptions)
                    throws MalformedURLException

Throws:

MalformedURLException

get

public T get()

Specified by:

get in interface Gettable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Returns:

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

require

public T require()

Specified by:

require in interface Requirable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Returns:

the item or throws an exception if the item doesn't exist.

getMandatory

public T getMandatory()

getRootPaths

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

edit

public T edit(UnaryOperator<T> function)

Description copied from interface: Editable

Issues a JSON patch against the item based upon the changes made to the object returned by the function.

It is generally convenient to use a Builder constructed off of the item.

Specified by:

edit in interface Editable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

function - to modify the item

Returns:

returns deserialized version of api server response

editStatus

public T editStatus(UnaryOperator<T> function)

Specified by:

editStatus in interface StatusEditable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

edit

public T edit(io.fabric8.kubernetes.api.builder.Visitor... visitors)

Description copied from interface: Editable

Issues a JSON patch against the item based upon the changes made to the object by the visitors.

Specified by:

edit in interface Editable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

visitors - to modify the Builder

Returns:

returns deserialized version of api server response

edit

public <V> T edit(Class<V> visitorType,
                  io.fabric8.kubernetes.api.builder.Visitor<V> visitor)

Description copied from interface: Editable

Issues a JSON patch against the item based upon the changes made to the object by the visitor.

Specified by:

edit in interface Editable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

visitorType - to create a TypedVisitor

visitor - to modify the Builder

Returns:

returns deserialized version of api server response

accept

public T accept(Consumer<T> consumer)

Description copied from interface: Editable

Issues a JSON patch against the item based upon the changes made by the function provided as argument

Specified by:

accept in interface Editable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

consumer - to modify the item

Returns:

returns deserialized version of api server response

withName

public R withName(String name)

Specified by:

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

lockResourceVersion

public Replaceable<T> lockResourceVersion(String resourceVersion)

Specified by:

lockResourceVersion in interface Lockable<Replaceable<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

inNamespace

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

Specified by:

inNamespace in interface Namespaceable<NonNamespaceOperation<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>,R extends Resource<T>>>

inAnyNamespace

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

Specified by:

inAnyNamespace in interface AnyNamespaceable<FilterWatchListMultiDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

cascading

public EditReplacePatchDeletable<T> cascading(boolean cascading)

Description copied from interface: Cascading

deletes dependent resources. Sets `orphanDependents` field to `false` when set `true`

Specified by:

cascading in interface Cascading<EditReplacePatchDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

Parameters:

cascading - whether dependents should be orphaned or not.

Returns:

resource

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>>

Parameters:

is - The input stream.

Returns:

returns de-serialized object

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>>

Parameters:

url - The url.

Returns:

returns de-serialized object

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>>

Parameters:

file - The file.

Returns:

returns de-serialized object

load

public R load(String path)

Description copied from interface: Loadable

Load from path.

Specified by:

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

Parameters:

path - The path.

Returns:

returns de-serialized object

fromServer

public Gettable<T> fromServer()

Specified by:

fromServer in interface FromServerable<Gettable<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

create

@SafeVarargs
public final T create(T... resources)

Specified by:

create in interface InOutCreateable<T extends io.fabric8.kubernetes.api.model.HasMetadata,T extends io.fabric8.kubernetes.api.model.HasMetadata>

create

public T create(T resource)

Specified by:

create in interface InOutCreateable<T extends io.fabric8.kubernetes.api.model.HasMetadata,T extends io.fabric8.kubernetes.api.model.HasMetadata>

createOrReplace

@SafeVarargs
public final T createOrReplace(T... items)

Description copied from interface: CreateOrReplaceable

Creates a provided resource in a Kubernetes Cluster. If creation fails with a HTTP_CONFLICT, it tries to replace resource.
The resourceVersion and other fields of the item may be modified by this call.

Specified by:

createOrReplace in interface CreateOrReplaceable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

items - to create or replace

Returns:

created item returned in kubernetes api response

withLabels

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

Specified by:

withLabels in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withLabelSelector

public FilterWatchListDeletable<T,L> withLabelSelector(io.fabric8.kubernetes.api.model.LabelSelector selector)

Specified by:

withLabelSelector in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withoutLabels

public FilterWatchListDeletable<T,L> withoutLabels(Map<String,String> labels)

Specified by:

withoutLabels in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withLabelIn

public FilterWatchListDeletable<T,L> withLabelIn(String key,
                                                 String... values)

Specified by:

withLabelIn in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withLabelNotIn

public FilterWatchListDeletable<T,L> withLabelNotIn(String key,
                                                    String... values)

Specified by:

withLabelNotIn in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withLabel

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

Specified by:

withLabel in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withoutLabel

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

Specified by:

withoutLabel in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withFields

public FilterWatchListDeletable<T,L> withFields(Map<String,String> fields)

Specified by:

withFields in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withField

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

Specified by:

withField in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withInvolvedObject

public FilterWatchListDeletable<T,L> withInvolvedObject(io.fabric8.kubernetes.api.model.ObjectReference objectReference)

Description copied from interface: Filterable

Filter with the object that this event is about.

Specified by:

withInvolvedObject in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

Parameters:

objectReference - ObjectReference for providing information of referred object

Returns:

filtered resource

withNewFilter

public FilterNested<FilterWatchListDeletable<T,L>> withNewFilter()

Description copied from interface: FilterWatchListDeletable

Accumulate a filter on the context, when done FilterNested.endFilter() or and must be called

Specified by:

withNewFilter in interface FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>

Returns:

a FilterNested

withoutFields

public FilterWatchListDeletable<T,L> withoutFields(Map<String,String> fields)

Specified by:

withoutFields in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

withoutField

public FilterWatchListDeletable<T,L> withoutField(String key,
                                                  String value)

Specified by:

withoutField in interface Filterable<FilterWatchListDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata,L extends io.fabric8.kubernetes.api.model.KubernetesResourceList<T>>>

getLabelQueryParam

public String getLabelQueryParam()

getFieldQueryParam

public String getFieldQueryParam()

list

public L list()

Specified by:

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

list

public L list(Integer limitVal,
              String continueVal)

Description copied from interface: Listable

List resources from APIServer.

Specified by:

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

Parameters:

limitVal - number of resources to list

continueVal - an offset to pick listing from

Returns:

resource list

list

public L list(io.fabric8.kubernetes.api.model.ListOptions listOptions)

Description copied from interface: Listable

List resource from Kubernetes API server.

Specified by:

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

Parameters:

listOptions - ListOptions is the query options to a standard REST list call.

Returns:

list of resource type

delete

public Boolean delete()

Description copied from interface: Deletable

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

Specified by:

delete in interface Deletable

Returns:

value indicating object was deleted or not

delete

@SafeVarargs
public final Boolean delete(T... items)

Specified by:

delete in interface MultiDeleteable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

delete

public Boolean delete(List<T> items)

Specified by:

delete in interface MultiDeleteable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

updateStatus

public T updateStatus(T item)

Description copied from interface: StatusUpdatable

When the status subresource is enabled, the /status subresource for the custom resource is exposed. It does a PUT requests to the /status subresource take a resource object and ignore changes to anything except the status stanza.

Specified by:

updateStatus in interface StatusUpdatable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

item - kubernetes object

Returns:

updated object

patchStatus

public T patchStatus(T item)

Description copied from interface: StatusPatchable

Does a PATCH request to the /status subresource ignoring changes to anything except the status stanza.

This method has the same patching behavior as Patchable.patch(PatchContext, Object), with PatchType.JSON_MERGE but against the status subresource.

Set the resourceVersion to null to prevent optimistic locking.

Specified by:

patchStatus in interface StatusPatchable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

item - kubernetes object

Returns:

updated object

withItem

public BaseOperation<T,L,R> withItem(T item)

withResourceVersion

public R withResourceVersion(String resourceVersion)

Specified by:

withResourceVersion in interface Versionable<WatchAndWaitable<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

watch

public Watch watch(Watcher<T> watcher)

Description copied from interface: Watchable

Watch returns Watch interface that watches requested resource

Specified by:

watch in interface Watchable<Watcher<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

Parameters:

watcher - Watcher interface of Kubernetes resource

Returns:

watch interface Watch

watch

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

Description copied from interface: Watchable

Watch returns Watch interface that watches requested resource from specified resourceVersion

Specified by:

watch in interface Watchable<Watcher<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

Parameters:

resourceVersion - resource version from where to start watch

watcher - Watcher interface of Kubernetes resource

Returns:

watch interface Watch

watch

public Watch watch(io.fabric8.kubernetes.api.model.ListOptions options,
                   Watcher<T> watcher)

Description copied from interface: Watchable

Watch returns Watch interface that watches requested resource

Specified by:

watch in interface Watchable<Watcher<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

Parameters:

options - options available for watch operation

watcher - Watcher interface of Kubernetes resource

Returns:

watch interface Watch

replace

public T replace(T item)

Description copied from interface: Replaceable

Replace the server's state with the given item. The resourceVersion and other fields of the item may be modified by this call.

If Lockable.lockResourceVersion(String) has been used to lock the resourceVersion, this operation is effectively a single update attempt against that version.

If Lockable.lockResourceVersion(String) has not been called, this operation will be retried a number of times in the event of a conflict. If a resourceVersion has been set on the item, the first update attempt will be made against that version. Subsequent attempts will fetch the latest resourceVersion from the server.

Specified by:

replace in interface Replaceable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

item - with the replacement state

Returns:

returns deserialized version of api server response

replaceStatus

public T replaceStatus(T item)

Description copied from interface: StatusReplaceable

Similar to Replaceable.replace(Object), but only affects the status subresource

Specified by:

replaceStatus in interface StatusReplaceable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

item - with the status subresource

Returns:

returns deserialized version of api server response

patch

public T patch(PatchContext patchContext,
               String patch)

Description copied from interface: Patchable

Update field(s) of a resource using type specified in PatchContext(defaults to strategic merge if not specified).

Specified by:

patch in interface Patchable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

patchContext - PatchContext for patch request

patch - The patch to be applied to the resource JSON file.

Returns:

The patch to be applied to the resource JSON file.

patch

public T patch(PatchContext patchContext,
               T item)

Description copied from interface: Patchable

Update field(s) of a resource using type specified in PatchContext(defaults to strategic merge if not specified).

• PatchType.JSON - will create a JSON patch against the current item. WARNING: This may overwrite concurrent changes (between when you obtained your item and the current state) in an unexpected way. Consider using edit instead. The resourceVersion and other fields of the item may be modified by this call.
• PatchType.JSON_MERGE - will send the serialization of the item as a JSON MERGE patch. Set the resourceVersion to null to prevent optimistic locking.
• PatchType.STRATEGIC_MERGE - will send the serialization of the item as a STRATEGIC MERGE patch. Set the resourceVersion to null to prevent optimistic locking.

Specified by:

patch in interface Patchable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

patchContext - PatchContext for patch request

item - to be patched with patched values

Returns:

returns deserialized version of api server response

isResourceNamespaced

public boolean isResourceNamespaced()

Overrides:

isResourceNamespaced in class OperationSupport

handleResponse

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

Throws:

ExecutionException

InterruptedException

IOException

handleCreate

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

Throws:

ExecutionException

InterruptedException

IOException

handleUpdate

protected T handleUpdate(T updated,
                         boolean status)
                  throws ExecutionException,
                         InterruptedException,
                         IOException

Throws:

ExecutionException

InterruptedException

IOException

handlePatch

protected T handlePatch(PatchContext context,
                        T current,
                        T updated,
                        boolean status)
                 throws ExecutionException,
                        InterruptedException,
                        IOException

Throws:

ExecutionException

InterruptedException

IOException

handlePatch

protected T handlePatch(T current,
                        Map<String,Object> patchedUpdate)
                 throws ExecutionException,
                        InterruptedException,
                        IOException

Throws:

ExecutionException

InterruptedException

IOException

sendPatchedObject

protected T sendPatchedObject(T oldObject,
                              T updatedObject)

handleScale

protected io.fabric8.kubernetes.api.model.autoscaling.v1.Scale handleScale(io.fabric8.kubernetes.api.model.autoscaling.v1.Scale scaleParam)

handleDeploymentRollback

protected io.fabric8.kubernetes.api.model.Status handleDeploymentRollback(io.fabric8.kubernetes.api.model.extensions.DeploymentRollback deploymentRollback)

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()

isReloadingFromServer

public Boolean isReloadingFromServer()

getGracePeriodSeconds

public Long getGracePeriodSeconds()

getPropagationPolicy

public io.fabric8.kubernetes.api.model.DeletionPropagation getPropagationPolicy()

getResourceT

public String getResourceT()

Overrides:

getResourceT in class OperationSupport

getType

public Class<T> getType()

getListType

public Class<L> getListType()

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 FilterWatchListDeletable<T,L> withGracePeriod(long gracePeriodSeconds)

Description copied from interface: GracePeriodConfigurable

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

Specified by:

withGracePeriod in interface GracePeriodConfigurable<Deletable>

Parameters:

gracePeriodSeconds - grace period integer value in seconds

Returns:

the object for which grace period is configured

withPropagationPolicy

public EditReplacePatchDeletable<T> withPropagationPolicy(io.fabric8.kubernetes.api.model.DeletionPropagation propagationPolicy)

Description copied from interface: PropagationPolicyConfigurable

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both.

The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Acceptable values are:
'Orphan' - orphan the dependents;
'Background' - allow the garbage collector to delete the dependents in the background;
'Foreground' - a cascading policy that deletes all dependents in the foreground.

Specified by:

withPropagationPolicy in interface PropagationPolicyConfigurable<EditReplacePatchDeletable<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

Parameters:

propagationPolicy - propagation policy in form of string DeletionPropagation

Returns:

resource

withWaitRetryBackoff

public BaseOperation<T,L,R> withWaitRetryBackoff(long initialBackoff,
                                                 TimeUnit backoffUnit,
                                                 double backoffMultiplier)

Description copied from interface: Waitable

Configure the backoff strategy to use when waiting for conditions, in case the watcher encounters a retryable error.

Specified by:

withWaitRetryBackoff in interface Waitable<T extends io.fabric8.kubernetes.api.model.HasMetadata,T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

initialBackoff - the value for the initial backoff on first error

backoffUnit - the TimeUnit for the initial backoff value

backoffMultiplier - what to multiply the backoff by on each subsequent error

Returns:

the waitable

getConfigType

protected Class<? extends Config> getConfigType()

updateApiVersion

protected void updateApiVersion(io.fabric8.kubernetes.api.model.KubernetesResourceList<T> list)

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

Parameters:

list - Kubernetes resource list

updateApiVersion

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

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

Parameters:

hasMetadata - object whose api version needs to be updated

getReadiness

public Readiness getReadiness()

isReady

public final boolean isReady()

Description copied from interface: Readiable

Check if the resource is ready. If no readiness check exists, this is just an existence check.

Specified by:

isReady in interface Readiable

Returns:

true if the resource exists and is ready.

waitUntilReady

public T waitUntilReady(long amount,
                        TimeUnit timeUnit)

Specified by:

waitUntilReady in interface Waitable<T extends io.fabric8.kubernetes.api.model.HasMetadata,T extends io.fabric8.kubernetes.api.model.HasMetadata>

waitUntilCondition

public T waitUntilCondition(Predicate<T> condition,
                            long amount,
                            TimeUnit timeUnit)

Specified by:

waitUntilCondition in interface Waitable<T extends io.fabric8.kubernetes.api.model.HasMetadata,T extends io.fabric8.kubernetes.api.model.HasMetadata>

informOnCondition

public CompletableFuture<List<T>> informOnCondition(Predicate<List<T>> condition)

Description copied from interface: Informable

Return a Future when the list at this context satisfies the given Predicate. The predicate will be tested against the state of the underlying informer store on every event. The returned future should be cancelled by the caller if not waiting for completion to close the underlying informer

Specified by:

informOnCondition in interface Informable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

condition - the Predicate to test

Returns:

a CompletableFuture of the list of items after the condition is met

setType

public void setType(Class<T> type)

setListType

public void setListType(Class<L> listType)

setNamespace

public void setNamespace(String namespace)

dryRun

public WritableOperation<T> dryRun(boolean isDryRun)

Description copied from interface: DryRunable

Indicates whether modifications should not be persisted or not. If enabled, All dry run stages will be processed. the request is still processed as typical request: the fields are defaulted, the object is validated, it goes through the validation admission chain, and through the mutating admission chain, and then the final object is returned to the user as it normally would, without being persisted.

Specified by:

dryRun in interface DryRunable<WritableOperation<T extends io.fabric8.kubernetes.api.model.HasMetadata>>

Parameters:

isDryRun - whether dry run is enabled or disabled

Returns:

write operations which are applicable for dry run

withIndexers

public Informable<T> withIndexers(Map<String,Function<T,List<String>>> indexers)

Description copied from interface: Informable

The indexers to add to SharedInformers created by subsequent inform calls;

Specified by:

withIndexers in interface Informable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

indexers - to customize the indexing

Returns:

the current Informable

inform

public SharedIndexInformer<T> inform(ResourceEventHandler<T> handler,
                                     long resync)

Description copied from interface: Informable

Similar to a Watch, but will attempt to handle failures after successfully started. and provides a store of all the current resources.

This call will be blocking for the initial list and watch.

You are expected to call stop to terminate the underlying Watch.

Additional handlers can be added, but processing of the events will be in the websocket thread, so consider non-blocking handler operations for more than one handler.

Specified by:

inform in interface Informable<T extends io.fabric8.kubernetes.api.model.HasMetadata>

Parameters:

handler - to notify

resync - the resync period or 0 for no resync

Returns:

a running SharedIndexInformer