Enum PipelineFailurePolicy

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<PipelineFailurePolicy>

    public enum PipelineFailurePolicy
    extends Enum<PipelineFailurePolicy>
    implements com.google.protobuf.ProtocolMessageEnum
     Represents the failure policy of a pipeline. Currently, the default of a
     pipeline is that the pipeline will continue to run until no more tasks can be
     executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a
     pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling
     any new tasks when a task has failed. Any scheduled tasks will continue to
     completion.
     
    Protobuf enum google.cloud.aiplatform.v1.PipelineFailurePolicy
    • Enum Constant Detail

      • PIPELINE_FAILURE_POLICY_UNSPECIFIED

        public static final PipelineFailurePolicy PIPELINE_FAILURE_POLICY_UNSPECIFIED
         Default value, and follows fail slow behavior.
         
        PIPELINE_FAILURE_POLICY_UNSPECIFIED = 0;
      • PIPELINE_FAILURE_POLICY_FAIL_SLOW

        public static final PipelineFailurePolicy PIPELINE_FAILURE_POLICY_FAIL_SLOW
         Indicates that the pipeline should continue to run until all possible
         tasks have been scheduled and completed.
         
        PIPELINE_FAILURE_POLICY_FAIL_SLOW = 1;
      • PIPELINE_FAILURE_POLICY_FAIL_FAST

        public static final PipelineFailurePolicy PIPELINE_FAILURE_POLICY_FAIL_FAST
         Indicates that the pipeline should stop scheduling new tasks after a task
         has failed.
         
        PIPELINE_FAILURE_POLICY_FAIL_FAST = 2;
    • Field Detail

      • PIPELINE_FAILURE_POLICY_UNSPECIFIED_VALUE

        public static final int PIPELINE_FAILURE_POLICY_UNSPECIFIED_VALUE
         Default value, and follows fail slow behavior.
         
        PIPELINE_FAILURE_POLICY_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • PIPELINE_FAILURE_POLICY_FAIL_SLOW_VALUE

        public static final int PIPELINE_FAILURE_POLICY_FAIL_SLOW_VALUE
         Indicates that the pipeline should continue to run until all possible
         tasks have been scheduled and completed.
         
        PIPELINE_FAILURE_POLICY_FAIL_SLOW = 1;
        See Also:
        Constant Field Values
      • PIPELINE_FAILURE_POLICY_FAIL_FAST_VALUE

        public static final int PIPELINE_FAILURE_POLICY_FAIL_FAST_VALUE
         Indicates that the pipeline should stop scheduling new tasks after a task
         has failed.
         
        PIPELINE_FAILURE_POLICY_FAIL_FAST = 2;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static PipelineFailurePolicy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (PipelineFailurePolicy c : PipelineFailurePolicy.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PipelineFailurePolicy valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum
      • valueOf

        @Deprecated
        public static PipelineFailurePolicy valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • forNumber

        public static PipelineFailurePolicy forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.
      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<PipelineFailurePolicy> internalGetValueMap()
      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
      • valueOf

        public static PipelineFailurePolicy valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null