Package k8s.io.apimachinery.pkg.apis.meta.v1

Class Generated.DeleteOptions

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Generated.DeleteOptionsOrBuilder
    Enclosing class:
    Generated
    public static final class Generated.DeleteOptions
extends com.google.protobuf.GeneratedMessageV3
implements Generated.DeleteOptionsOrBuilder
     DeleteOptions may be provided when deleting an API object.
    Protobuf type k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions
    See Also:
    Serialized Form

    • Field Detail

      • GRACEPERIODSECONDS_FIELD_NUMBER

        public static final int GRACEPERIODSECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRECONDITIONS_FIELD_NUMBER

        public static final int PRECONDITIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ORPHANDEPENDENTS_FIELD_NUMBER

        public static final int ORPHANDEPENDENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROPAGATIONPOLICY_FIELD_NUMBER

        public static final int PROPAGATIONPOLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IGNORESTOREREADERRORWITHCLUSTERBREAKINGPOTENTIAL_FIELD_NUMBER

        public static final int IGNORESTOREREADERRORWITHCLUSTERBREAKINGPOTENTIAL_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasGracePeriodSeconds

        public boolean hasGracePeriodSeconds()
         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.
 +optional
        optional int64 gracePeriodSeconds = 1;
        Specified by:
        hasGracePeriodSeconds in interface Generated.DeleteOptionsOrBuilder
        Returns:
        Whether the gracePeriodSeconds field is set.

      • getGracePeriodSeconds

        public long 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.
 +optional
        optional int64 gracePeriodSeconds = 1;
        Specified by:
        getGracePeriodSeconds in interface Generated.DeleteOptionsOrBuilder
        Returns:
        The gracePeriodSeconds.

      • hasPreconditions

        public boolean hasPreconditions()
         Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
 returned.
 +k8s:conversion-gen=false
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions preconditions = 2;
        Specified by:
        hasPreconditions in interface Generated.DeleteOptionsOrBuilder
        Returns:
        Whether the preconditions field is set.

      • getPreconditions

        public Generated.Preconditions getPreconditions()
         Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
 returned.
 +k8s:conversion-gen=false
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions preconditions = 2;
        Specified by:
        getPreconditions in interface Generated.DeleteOptionsOrBuilder
        Returns:
        The preconditions.

      • hasOrphanDependents

        public boolean hasOrphanDependents()
         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.
 +optional
        optional bool orphanDependents = 3;
        Specified by:
        hasOrphanDependents in interface Generated.DeleteOptionsOrBuilder
        Returns:
        Whether the orphanDependents field is set.

      • getOrphanDependents

        public boolean 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.
 +optional
        optional bool orphanDependents = 3;
        Specified by:
        getOrphanDependents in interface Generated.DeleteOptionsOrBuilder
        Returns:
        The orphanDependents.

      • hasPropagationPolicy

        public boolean hasPropagationPolicy()
         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.
 +optional
        optional string propagationPolicy = 4;
        Specified by:
        hasPropagationPolicy in interface Generated.DeleteOptionsOrBuilder
        Returns:
        Whether the propagationPolicy field is set.

      • getPropagationPolicy

        public String 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.
 +optional
        optional string propagationPolicy = 4;
        Specified by:
        getPropagationPolicy in interface Generated.DeleteOptionsOrBuilder
        Returns:
        The propagationPolicy.

      • getPropagationPolicyBytes

        public com.google.protobuf.ByteString getPropagationPolicyBytes()
         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.
 +optional
        optional string propagationPolicy = 4;
        Specified by:
        getPropagationPolicyBytes in interface Generated.DeleteOptionsOrBuilder
        Returns:
        The bytes for propagationPolicy.

      • getDryRunList

        public com.google.protobuf.ProtocolStringList getDryRunList()
         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
 +optional
 +listType=atomic
        repeated string dryRun = 5;
        Specified by:
        getDryRunList in interface Generated.DeleteOptionsOrBuilder
        Returns:
        A list containing the dryRun.

      • getDryRunCount

        public int getDryRunCount()
         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
 +optional
 +listType=atomic
        repeated string dryRun = 5;
        Specified by:
        getDryRunCount in interface Generated.DeleteOptionsOrBuilder
        Returns:
        The count of dryRun.

      • getDryRun

        public String getDryRun​(int index)
         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
 +optional
 +listType=atomic
        repeated string dryRun = 5;
        Specified by:
        getDryRun in interface Generated.DeleteOptionsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The dryRun at the given index.

      • getDryRunBytes

        public com.google.protobuf.ByteString getDryRunBytes​(int index)
         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
 +optional
 +listType=atomic
        repeated string dryRun = 5;
        Specified by:
        getDryRunBytes in interface Generated.DeleteOptionsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the dryRun at the given index.

      • hasIgnoreStoreReadErrorWithClusterBreakingPotential

        public boolean hasIgnoreStoreReadErrorWithClusterBreakingPotential()
         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
 +optional
        optional bool ignoreStoreReadErrorWithClusterBreakingPotential = 6;
        Specified by:
        hasIgnoreStoreReadErrorWithClusterBreakingPotential in interface Generated.DeleteOptionsOrBuilder
        Returns:
        Whether the ignoreStoreReadErrorWithClusterBreakingPotential field is set.

      • getIgnoreStoreReadErrorWithClusterBreakingPotential

        public boolean 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
 +optional
        optional bool ignoreStoreReadErrorWithClusterBreakingPotential = 6;
        Specified by:
        getIgnoreStoreReadErrorWithClusterBreakingPotential in interface Generated.DeleteOptionsOrBuilder
        Returns:
        The ignoreStoreReadErrorWithClusterBreakingPotential.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Generated.DeleteOptions parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.DeleteOptions parseFrom​(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.DeleteOptions parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.DeleteOptions parseFrom​(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.DeleteOptions parseFrom​(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.DeleteOptions parseFrom​(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public Generated.DeleteOptions.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Generated.DeleteOptions.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Generated.DeleteOptions.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Generated.DeleteOptions> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Generated.DeleteOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder