Enum Execution.State

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Execution.State>
    Enclosing class:
    Execution

    public static enum Execution.State
    extends Enum<Execution.State>
    implements com.google.protobuf.ProtocolMessageEnum
     Enum description of the state of the underlying AIP job.
     
    Protobuf enum google.cloud.notebooks.v1.Execution.State
    • Enum Constant Detail

      • STATE_UNSPECIFIED

        public static final Execution.State STATE_UNSPECIFIED
         The job state is unspecified.
         
        STATE_UNSPECIFIED = 0;
      • QUEUED

        public static final Execution.State QUEUED
         The job has been just created and processing has not yet begun.
         
        QUEUED = 1;
      • PREPARING

        public static final Execution.State PREPARING
         The service is preparing to execution the job.
         
        PREPARING = 2;
      • RUNNING

        public static final Execution.State RUNNING
         The job is in progress.
         
        RUNNING = 3;
      • SUCCEEDED

        public static final Execution.State SUCCEEDED
         The job completed successfully.
         
        SUCCEEDED = 4;
      • FAILED

        public static final Execution.State FAILED
         The job failed.
         `error_message` should contain the details of the failure.
         
        FAILED = 5;
      • CANCELLING

        public static final Execution.State CANCELLING
         The job is being cancelled.
         `error_message` should describe the reason for the cancellation.
         
        CANCELLING = 6;
      • CANCELLED

        public static final Execution.State CANCELLED
         The job has been cancelled.
         `error_message` should describe the reason for the cancellation.
         
        CANCELLED = 7;
      • EXPIRED

        public static final Execution.State EXPIRED
         The job has become expired (relevant to Vertex AI jobs)
         https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
         
        EXPIRED = 9;
      • INITIALIZING

        public static final Execution.State INITIALIZING
         The Execution is being created.
         
        INITIALIZING = 10;
    • Field Detail

      • STATE_UNSPECIFIED_VALUE

        public static final int STATE_UNSPECIFIED_VALUE
         The job state is unspecified.
         
        STATE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • QUEUED_VALUE

        public static final int QUEUED_VALUE
         The job has been just created and processing has not yet begun.
         
        QUEUED = 1;
        See Also:
        Constant Field Values
      • PREPARING_VALUE

        public static final int PREPARING_VALUE
         The service is preparing to execution the job.
         
        PREPARING = 2;
        See Also:
        Constant Field Values
      • RUNNING_VALUE

        public static final int RUNNING_VALUE
         The job is in progress.
         
        RUNNING = 3;
        See Also:
        Constant Field Values
      • SUCCEEDED_VALUE

        public static final int SUCCEEDED_VALUE
         The job completed successfully.
         
        SUCCEEDED = 4;
        See Also:
        Constant Field Values
      • FAILED_VALUE

        public static final int FAILED_VALUE
         The job failed.
         `error_message` should contain the details of the failure.
         
        FAILED = 5;
        See Also:
        Constant Field Values
      • CANCELLING_VALUE

        public static final int CANCELLING_VALUE
         The job is being cancelled.
         `error_message` should describe the reason for the cancellation.
         
        CANCELLING = 6;
        See Also:
        Constant Field Values
      • CANCELLED_VALUE

        public static final int CANCELLED_VALUE
         The job has been cancelled.
         `error_message` should describe the reason for the cancellation.
         
        CANCELLED = 7;
        See Also:
        Constant Field Values
      • EXPIRED_VALUE

        public static final int EXPIRED_VALUE
         The job has become expired (relevant to Vertex AI jobs)
         https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
         
        EXPIRED = 9;
        See Also:
        Constant Field Values
      • INITIALIZING_VALUE

        public static final int INITIALIZING_VALUE
         The Execution is being created.
         
        INITIALIZING = 10;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static Execution.State[] 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 (Execution.State c : Execution.State.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Execution.State 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 Execution.State 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 Execution.State 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<Execution.State> 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 Execution.State 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