Package org.cdk8s.plus24.k8s
Class DeleteOptions.Builder
- java.lang.Object
-
- org.cdk8s.plus24.k8s.DeleteOptions.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<DeleteOptions>
- Enclosing interface:
- DeleteOptions
@Stability(Stable) public static final class DeleteOptions.Builder extends Object implements software.amazon.jsii.Builder<DeleteOptions>
A builder forDeleteOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DeleteOptions.Builder
apiVersion(String apiVersion)
Sets the value ofDeleteOptions.getApiVersion()
DeleteOptions
build()
Builds the configured instance.DeleteOptions.Builder
dryRun(List<String> dryRun)
Sets the value ofDeleteOptions.getDryRun()
DeleteOptions.Builder
gracePeriodSeconds(Number gracePeriodSeconds)
Sets the value ofDeleteOptions.getGracePeriodSeconds()
DeleteOptions.Builder
kind(IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind kind)
Sets the value ofDeleteOptions.getKind()
DeleteOptions.Builder
orphanDependents(Boolean orphanDependents)
Sets the value ofDeleteOptions.getOrphanDependents()
DeleteOptions.Builder
preconditions(Preconditions preconditions)
Sets the value ofDeleteOptions.getPreconditions()
DeleteOptions.Builder
propagationPolicy(String propagationPolicy)
Sets the value ofDeleteOptions.getPropagationPolicy()
-
-
-
Method Detail
-
apiVersion
@Stability(Stable) public DeleteOptions.Builder apiVersion(String apiVersion)
Sets the value ofDeleteOptions.getApiVersion()
- Parameters:
apiVersion
- 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- Returns:
this
-
dryRun
@Stability(Stable) public DeleteOptions.Builder dryRun(List<String> dryRun)
Sets the value ofDeleteOptions.getDryRun()
- Parameters:
dryRun
- 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- Returns:
this
-
gracePeriodSeconds
@Stability(Stable) public DeleteOptions.Builder gracePeriodSeconds(Number gracePeriodSeconds)
Sets the value ofDeleteOptions.getGracePeriodSeconds()
- Parameters:
gracePeriodSeconds
- 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.- Returns:
this
-
kind
@Stability(Stable) public DeleteOptions.Builder kind(IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind kind)
Sets the value ofDeleteOptions.getKind()
- Parameters:
kind
- 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- Returns:
this
-
orphanDependents
@Stability(Stable) public DeleteOptions.Builder orphanDependents(Boolean orphanDependents)
Sets the value ofDeleteOptions.getOrphanDependents()
- Parameters:
orphanDependents
- 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.- Returns:
this
-
preconditions
@Stability(Stable) public DeleteOptions.Builder preconditions(Preconditions preconditions)
Sets the value ofDeleteOptions.getPreconditions()
- Parameters:
preconditions
- Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.- Returns:
this
-
propagationPolicy
@Stability(Stable) public DeleteOptions.Builder propagationPolicy(String propagationPolicy)
Sets the value ofDeleteOptions.getPropagationPolicy()
- Parameters:
propagationPolicy
- 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.- Returns:
this
-
build
@Stability(Stable) public DeleteOptions build()
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DeleteOptions>
- Returns:
- a new instance of
DeleteOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-
-