Class V1DeleteOptions

DeleteOptions may be provided when deleting an API object.

Inheritance
object
V1DeleteOptions
Implements
Inherited Members
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
[KubernetesEntity(Group = "", Kind = "DeleteOptions", ApiVersion = "v1", PluralName = "")]
public record V1DeleteOptions : IKubernetesObject, IEquatable<V1DeleteOptions>

Constructors

V1DeleteOptions()

Declaration
public V1DeleteOptions()

V1DeleteOptions(V1DeleteOptions)

Declaration
protected V1DeleteOptions(V1DeleteOptions original)
Parameters
Type Name Description
V1DeleteOptions original

Fields

KubeApiVersion

Declaration
public const string KubeApiVersion = "v1"
Field Value
Type Description
string

KubeGroup

Declaration
public const string KubeGroup = ""
Field Value
Type Description
string

KubeKind

Declaration
public const string KubeKind = "DeleteOptions"
Field Value
Type Description
string

KubePluralName

Declaration
public const string KubePluralName = ""
Field Value
Type Description
string

Properties

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

Declaration
[JsonPropertyName("apiVersion")]
public string ApiVersion { get; set; }
Property Value
Type Description
string

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
Type Description
IList<string>

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type

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
Type Description
long?

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
Type Description
bool?

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

Declaration
[JsonPropertyName("kind")]
public string Kind { get; set; }
Property Value
Type Description
string

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
Type Description
bool?

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
Type Description
V1Preconditions

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
Type Description
string

Methods

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

Equals(V1DeleteOptions?)

Declaration
public virtual bool Equals(V1DeleteOptions? other)
Parameters
Type Name Description
V1DeleteOptions other
Returns
Type Description
bool

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

operator ==(V1DeleteOptions?, V1DeleteOptions?)

Declaration
public static bool operator ==(V1DeleteOptions? left, V1DeleteOptions? right)
Parameters
Type Name Description
V1DeleteOptions left
V1DeleteOptions right
Returns
Type Description
bool

operator !=(V1DeleteOptions?, V1DeleteOptions?)

Declaration
public static bool operator !=(V1DeleteOptions? left, V1DeleteOptions? right)
Parameters
Type Name Description
V1DeleteOptions left
V1DeleteOptions right
Returns
Type Description
bool

Implements

Extension Methods