Class V1DeleteOptions
java.lang.Object
io.kubernetes.client.openapi.models.V1DeleteOptions
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2025-02-12T21:15:49.397498Z[Etc/UTC]",
comments="Generator version: 7.6.0")
public class V1DeleteOptions
extends Object
DeleteOptions may be provided when deleting an API object.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddDryRunItem
(String dryRunItem) apiVersion
(String apiVersion) boolean
static V1DeleteOptions
Create an instance of V1DeleteOptions given an JSON stringAPIVersion defines the versioned schema of this representation of an object.When present, indicates that modifications should not be persisted.The duration in seconds before the object should be deleted.if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error.getKind()
Kind is a string value representing the REST resource this object represents.Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.Get preconditionsWhether and how garbage collection will be performed.gracePeriodSeconds
(Long gracePeriodSeconds) int
hashCode()
ignoreStoreReadErrorWithClusterBreakingPotential
(Boolean ignoreStoreReadErrorWithClusterBreakingPotential) orphanDependents
(Boolean orphanDependents) preconditions
(V1Preconditions preconditions) propagationPolicy
(String propagationPolicy) void
setApiVersion
(String apiVersion) void
void
setGracePeriodSeconds
(Long gracePeriodSeconds) void
setIgnoreStoreReadErrorWithClusterBreakingPotential
(Boolean ignoreStoreReadErrorWithClusterBreakingPotential) void
void
setOrphanDependents
(Boolean orphanDependents) void
setPreconditions
(V1Preconditions preconditions) void
setPropagationPolicy
(String propagationPolicy) toJson()
Convert an instance of V1DeleteOptions to an JSON stringtoString()
static void
validateJsonElement
(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_API_VERSION
- See Also:
-
SERIALIZED_NAME_DRY_RUN
- See Also:
-
SERIALIZED_NAME_GRACE_PERIOD_SECONDS
- See Also:
-
SERIALIZED_NAME_IGNORE_STORE_READ_ERROR_WITH_CLUSTER_BREAKING_POTENTIAL
- See Also:
-
SERIALIZED_NAME_KIND
- See Also:
-
SERIALIZED_NAME_ORPHAN_DEPENDENTS
- See Also:
-
SERIALIZED_NAME_PRECONDITIONS
- See Also:
-
SERIALIZED_NAME_PROPAGATION_POLICY
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
V1DeleteOptions
public V1DeleteOptions()
-
-
Method Details
-
apiVersion
-
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- Returns:
- apiVersion
-
setApiVersion
-
dryRun
-
addDryRunItem
-
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- Returns:
- dryRun
-
setDryRun
-
gracePeriodSeconds
-
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.- Returns:
- gracePeriodSeconds
-
setGracePeriodSeconds
-
ignoreStoreReadErrorWithClusterBreakingPotential
public V1DeleteOptions ignoreStoreReadErrorWithClusterBreakingPotential(Boolean ignoreStoreReadErrorWithClusterBreakingPotential) -
getIgnoreStoreReadErrorWithClusterBreakingPotential
if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it- Returns:
- ignoreStoreReadErrorWithClusterBreakingPotential
-
setIgnoreStoreReadErrorWithClusterBreakingPotential
public void setIgnoreStoreReadErrorWithClusterBreakingPotential(Boolean ignoreStoreReadErrorWithClusterBreakingPotential) -
kind
-
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- Returns:
- kind
-
setKind
-
orphanDependents
-
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.- Returns:
- orphanDependents
-
setOrphanDependents
-
preconditions
-
getPreconditions
Get preconditions- Returns:
- preconditions
-
setPreconditions
-
propagationPolicy
-
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.- Returns:
- propagationPolicy
-
setPropagationPolicy
-
equals
-
hashCode
public int hashCode() -
toString
-
validateJsonElement
Validates the JSON Element and throws an exception if issues found- Parameters:
jsonElement
- JSON Element- Throws:
IOException
- if the JSON Element is invalid with respect to V1DeleteOptions
-
fromJson
Create an instance of V1DeleteOptions given an JSON string- Parameters:
jsonString
- JSON string- Returns:
- An instance of V1DeleteOptions
- Throws:
IOException
- if the JSON string is invalid with respect to V1DeleteOptions
-
toJson
Convert an instance of V1DeleteOptions to an JSON string- Returns:
- JSON string
-