Package org.cdk8s.plus24.k8s

Interface DeleteOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeleteOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-24T11:18:28.656Z")
@Stability(Stable)
public interface DeleteOptions
extends software.amazon.jsii.JsiiSerializable

DeleteOptions may be provided when deleting an API object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DeleteOptions.Builder	A builder for DeleteOptions
static class	DeleteOptions.Jsii$Proxy	An implementation for DeleteOptions

Method Summary

Modifier and Type	Method	Description
static DeleteOptions.Builder	builder()
default String	getApiVersion()	APIVersion defines the versioned schema of this representation of an object.
default List<String>	getDryRun()	When present, indicates that modifications should not be persisted.
default Number	getGracePeriodSeconds()	The duration in seconds before the object should be deleted.
default IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind	getKind()	Kind is a string value representing the REST resource this object represents.
default Boolean	getOrphanDependents()	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
default Preconditions	getPreconditions()	Must be fulfilled before a deletion is carried out.
default String	getPropagationPolicy()	Whether and how garbage collection will be performed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiVersion

@Stability(Stable)
@Nullable
default String getApiVersion()

APIVersion defines the versioned schema of this representation of an object.

Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

getDryRun

@Stability(Stable)
@Nullable
default List<String> getDryRun()

When present, indicates that modifications should not be persisted.

An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

getGracePeriodSeconds

@Stability(Stable)
@Nullable
default Number getGracePeriodSeconds()

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.

Default: a per object value if not specified. zero means delete immediately.

getKind

@Stability(Stable)
@Nullable
default IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind getKind()

Kind is a string value representing the REST resource this object represents.

Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

getOrphanDependents

@Stability(Stable)
@Nullable
default Boolean getOrphanDependents()

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

getPreconditions

@Stability(Stable)
@Nullable
default Preconditions getPreconditions()

Must be fulfilled before a deletion is carried out.

If not possible, a 409 Conflict status will be returned.

getPropagationPolicy

@Stability(Stable)
@Nullable
default String getPropagationPolicy()

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.

builder

@Stability(Stable)
static DeleteOptions.Builder builder()

Returns:

a DeleteOptions.Builder of DeleteOptions