Class V1DeleteOptions
DeleteOptions may be provided when deleting an API object.
Inheritance
V1DeleteOptions
Assembly: KubernetesClient.dll
Syntax
[KubernetesEntity(Group = "", Kind = "DeleteOptions", ApiVersion = "v1", PluralName = "")]
public record V1DeleteOptions : IKubernetesObject, IEquatable<V1DeleteOptions>
Constructors
View Source
V1DeleteOptions()
Declaration
View Source
V1DeleteOptions(V1DeleteOptions)
Declaration
protected V1DeleteOptions(V1DeleteOptions original)
Parameters
Fields
View Source
KubeApiVersion
Declaration
public const string KubeApiVersion = "v1"
Field Value
View Source
KubeGroup
Declaration
public const string KubeGroup = ""
Field Value
View Source
KubeKind
Declaration
public const string KubeKind = "DeleteOptions"
Field Value
View Source
KubePluralName
Declaration
public const string KubePluralName = ""
Field Value
Properties
View Source
ApiVersion
Declaration
[JsonPropertyName("apiVersion")]
public string ApiVersion { get; set; }
Property Value
View Source
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
Declaration
[JsonPropertyName("dryRun")]
public IList<string> DryRun { get; set; }
Property Value
View Source
EqualityContract
Declaration
protected virtual Type EqualityContract { get; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("gracePeriodSeconds")]
public long? GracePeriodSeconds { get; set; }
Property Value
View Source
IgnoreStoreReadErrorWithClusterBreakingPotential
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
Declaration
[JsonPropertyName("ignoreStoreReadErrorWithClusterBreakingPotential")]
public bool? IgnoreStoreReadErrorWithClusterBreakingPotential { get; set; }
Property Value
View Source
Kind
Declaration
[JsonPropertyName("kind")]
public string Kind { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("orphanDependents")]
public bool? OrphanDependents { get; set; }
Property Value
View Source
Preconditions
Must be fulfilled before a deletion is carried out. If not possible, a 409
Conflict status will be returned.
Declaration
[JsonPropertyName("preconditions")]
public V1Preconditions Preconditions { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("propagationPolicy")]
public string PropagationPolicy { get; set; }
Property Value
Methods
View Source
Equals(object?)
Declaration
public override bool Equals(object? obj)
Parameters
| Type |
Name |
Description |
| object |
obj |
|
Returns
Overrides
View Source
Equals(V1DeleteOptions?)
Declaration
public virtual bool Equals(V1DeleteOptions? other)
Parameters
Returns
View Source
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
View Source
PrintMembers(StringBuilder)
Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Returns
View Source
ToString()
Declaration
public override string ToString()
Returns
Overrides
Operators
View Source
operator ==(V1DeleteOptions?, V1DeleteOptions?)
Declaration
public static bool operator ==(V1DeleteOptions? left, V1DeleteOptions? right)
Parameters
Returns
View Source
operator !=(V1DeleteOptions?, V1DeleteOptions?)
Declaration
public static bool operator !=(V1DeleteOptions? left, V1DeleteOptions? right)
Parameters
Returns
Implements
Extension Methods