kubernetes_asyncio.client.models.v1_delete_options module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_delete_options.V1DeleteOptions(api_version=None, dry_run=None, grace_period_seconds=None, ignore_store_read_error_with_cluster_breaking_potential=None, kind=None, orphan_dependents=None, preconditions=None, propagation_policy=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

property api_version

Gets the api_version of this V1DeleteOptions. # noqa: E501

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 # noqa: E501

Returns:

The api_version of this V1DeleteOptions. # noqa: E501

Return type:

str

attribute_map = {'api_version': 'apiVersion', 'dry_run': 'dryRun', 'grace_period_seconds': 'gracePeriodSeconds', 'ignore_store_read_error_with_cluster_breaking_potential': 'ignoreStoreReadErrorWithClusterBreakingPotential', 'kind': 'kind', 'orphan_dependents': 'orphanDependents', 'preconditions': 'preconditions', 'propagation_policy': 'propagationPolicy'}

property dry_run

Gets the dry_run of this V1DeleteOptions. # noqa: E501

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 # noqa: E501

Returns:

The dry_run of this V1DeleteOptions. # noqa: E501

Return type:

list[str]

property grace_period_seconds

Gets the grace_period_seconds of this V1DeleteOptions. # noqa: E501

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. # noqa: E501

Returns:

The grace_period_seconds of this V1DeleteOptions. # noqa: E501

Return type:

int

property ignore_store_read_error_with_cluster_breaking_potential

Gets the ignore_store_read_error_with_cluster_breaking_potential of this V1DeleteOptions. # noqa: E501

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 # noqa: E501

Returns:

The ignore_store_read_error_with_cluster_breaking_potential of this V1DeleteOptions. # noqa: E501

Return type:

bool

property kind

Gets the kind of this V1DeleteOptions. # noqa: E501

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 # noqa: E501

Returns:

The kind of this V1DeleteOptions. # noqa: E501

Return type:

str

openapi_types = {'api_version': 'str', 'dry_run': 'list[str]', 'grace_period_seconds': 'int', 'ignore_store_read_error_with_cluster_breaking_potential': 'bool', 'kind': 'str', 'orphan_dependents': 'bool', 'preconditions': 'V1Preconditions', 'propagation_policy': 'str'}

property orphan_dependents

Gets the orphan_dependents of this V1DeleteOptions. # noqa: E501

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. # noqa: E501

Returns:

The orphan_dependents of this V1DeleteOptions. # noqa: E501

Return type:

bool

property preconditions

Gets the preconditions of this V1DeleteOptions. # noqa: E501

Returns:

The preconditions of this V1DeleteOptions. # noqa: E501

Return type:

V1Preconditions

property propagation_policy

Gets the propagation_policy of this V1DeleteOptions. # noqa: E501

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. # noqa: E501

Returns:

The propagation_policy of this V1DeleteOptions. # noqa: E501

Return type:

str

to_dict(serialize=False)

Returns the model properties as a dict

to_str()

Returns the string representation of the model