io.fabric8.kubernetes.client.dsl.base

Class HasMetadataOperation<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.CreateOnlyResourceOperation<T,T>

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

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

All Implemented Interfaces:

AnyNamespaceable<FilterWatchListMultiDeletable<T,L>>, Cascading<EditReplacePatchDeletable<T>>, CascadingEditReplacePatchDeletable<T>, Createable<T>, CreateFromServerGettable<T>, CreateOrDeleteable<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<ReplaceDeletable<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>, ReplaceDeletable<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>, ListerWatcher<T,L>, OperationInfo, PropagationPolicyConfigurable<EditReplacePatchDeletable<T>>

Direct Known Subclasses:

BindingOperationsImpl, CertificateSigningRequestOperationsImpl, ComponentStatusOperationsImpl, CronJobOperationsImpl, GenericKubernetesResourceOperationsImpl, HasMetadataOperationsImpl, JobOperationsImpl, PodOperationsImpl, RollableScalableResourceOperation, ServiceOperationsImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_GRACE_PERIOD_IN_SECONDS
static io.fabric8.kubernetes.api.model.DeletionPropagation	DEFAULT_PROPAGATION_POLICY

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

apiVersion, listType

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

type

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

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

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

DEFAULT_BACKOFF_MULTIPLIER, DEFAULT_INITIAL_BACKOFF_MILLIS

Constructor Summary

Constructors

Constructor and Description
HasMetadataOperation(OperationContext ctx, Class<T> type, Class<L> listType)

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
protected <V extends io.fabric8.kubernetes.api.builder.VisitableBuilder<T,V>> io.fabric8.kubernetes.api.builder.VisitableBuilder<T,V>	createVisitableBuilder(T item)
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 T	modifyItemForReplaceOrPatch(Supplier<T> current, T item) Modify the item prior to a replace or a JSON patch diff
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).
protected T	patch(PatchContext context, T base, T item, boolean status)
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.
protected T	replace(T item, boolean status) base replace operation, which is effectively a forced update with retries
T	replaceStatus(T item) Similar to Replaceable.replace(Object), but only affects the status subresource
protected T	requireFromServer() Get the current item from the server Will always return non-null or throw an exception.
protected T	requireFromServer(io.fabric8.kubernetes.api.model.ObjectMeta metadata) Get the current item from the server, consulting the metadata for the name if needed Will always return non-null or throw an exception.
protected void	validateOperation(Class<T> type)

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

appendListOptionParams, cascading, createOrReplace, delete, delete, delete, dryRun, edit, fetchListUrl, forOperationType, fromServer, get, getConfigType, getFieldQueryParam, getGracePeriodSeconds, getGroup, getItem, getKind, getLabelQueryParam, getLimit, getListType, getMandatory, getOperationType, getPlural, getPropagationPolicy, getReadiness, getResourceVersion, getVersion, handleCreate, handleDeploymentRollback, handleGet, handlePatch, handlePatch, handleResponse, handleScale, handleUpdate, inAnyNamespace, inform, informOnCondition, inNamespace, isCascading, isReady, isReloadingFromServer, isResourceNamespaced, list, list, list, load, load, load, load, lockResourceVersion, require, runnableInformer, sendPatchedObject, setListType, setNamespace, setType, updateApiVersion, updateApiVersion, updateStatus, waitUntilCondition, waitUntilReady, watch, watch, watch, withField, withFields, withGracePeriod, withIndexers, withInvolvedObject, withItem, withLabel, withLabelIn, withLabelNotIn, withLabels, withLabelSelector, withLabelSelector, withLimit, withName, withNewFilter, withoutField, withoutFields, withoutLabel, withoutLabels, withPropagationPolicy, withResourceVersion, withWaitRetryBackoff

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

create, create, getType

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, getResourceT, getResourceUrl, getResourceUrl, getResourceUrl, getResourceURLForPatchOperation, getResourceURLForWriteOperation, getRootUrl, handleCreate, handleDelete, handleDelete, handleDeploymentRollback, handleGet, handleGet, handleMetric, handlePatch, handlePatch, handlePatch, handleRawGet, handleResponse, handleResponse, handleResponse, handleResponse, handleScale, handleUpdate, handleUpdate, requestException, requestException, requestFailure, requestFailure, restCall, 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

getFullResourceName, 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.DryRunable

dryRun

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

patch, patch

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

create, create

Methods inherited from interface io.fabric8.kubernetes.client.informers.ListerWatcher

getNamespace

Field Detail

DEFAULT_PROPAGATION_POLICY

public static final io.fabric8.kubernetes.api.model.DeletionPropagation DEFAULT_PROPAGATION_POLICY

DEFAULT_GRACE_PERIOD_IN_SECONDS

public static final long DEFAULT_GRACE_PERIOD_IN_SECONDS

See Also:

Constant Field Values

Constructor Detail

HasMetadataOperation

public HasMetadataOperation(OperationContext ctx,
                            Class<T> type,
                            Class<L> listType)

Method Detail

validateOperation

protected void validateOperation(Class<T> type)

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>

Overrides:

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

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>

Overrides:

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

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>

Overrides:

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

Parameters:

consumer - to modify the item

Returns:

returns deserialized version of api server response

createVisitableBuilder

protected <V extends io.fabric8.kubernetes.api.builder.VisitableBuilder<T,V>> io.fabric8.kubernetes.api.builder.VisitableBuilder<T,V> createVisitableBuilder(T item)

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>

Overrides:

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

Parameters:

visitors - to modify the Builder

Returns:

returns deserialized version of api server response

requireFromServer

protected T requireFromServer()

Get the current item from the server
Will always return non-null or throw an exception.

requireFromServer

protected T requireFromServer(io.fabric8.kubernetes.api.model.ObjectMeta metadata)

Get the current item from the server, consulting the metadata for the name if needed
Will always return non-null or throw an exception.

replace

public T replace(T item)

Description copied from interface: Replaceable

Replace the server's state with the given item.

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>

Overrides:

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

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>

Overrides:

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

Parameters:

item - with the status subresource

Returns:

returns deserialized version of api server response

modifyItemForReplaceOrPatch

protected T modifyItemForReplaceOrPatch(Supplier<T> current,
                                        T item)

Modify the item prior to a replace or a JSON patch diff

Parameters:

current - item from the server

item - to be modified

Returns:

the modified item

replace

protected T replace(T item,
                    boolean status)

base replace operation, which is effectively a forced update with retries

patch

protected T patch(PatchContext context,
                  T base,
                  T item,
                  boolean status)

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>

Overrides:

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

Parameters:

item - kubernetes object

Returns:

updated object

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

Overrides:

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

Parameters:

patchContext - PatchContext for patch request

item - to be patched with patched values

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>

Overrides:

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

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.

newInstance

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

Overrides:

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