Enum JobState

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

    public enum JobState
    extends Enum<JobState>
    implements com.google.protobuf.ProtocolMessageEnum
     Describes the state of a job.
     
    Protobuf enum google.cloud.aiplatform.v1beta1.JobState
    • Enum Constant Detail

      • JOB_STATE_UNSPECIFIED

        public static final JobState JOB_STATE_UNSPECIFIED
         The job state is unspecified.
         
        JOB_STATE_UNSPECIFIED = 0;
      • JOB_STATE_QUEUED

        public static final JobState JOB_STATE_QUEUED
         The job has been just created or resumed and processing has not yet begun.
         
        JOB_STATE_QUEUED = 1;
      • JOB_STATE_PENDING

        public static final JobState JOB_STATE_PENDING
         The service is preparing to run the job.
         
        JOB_STATE_PENDING = 2;
      • JOB_STATE_RUNNING

        public static final JobState JOB_STATE_RUNNING
         The job is in progress.
         
        JOB_STATE_RUNNING = 3;
      • JOB_STATE_SUCCEEDED

        public static final JobState JOB_STATE_SUCCEEDED
         The job completed successfully.
         
        JOB_STATE_SUCCEEDED = 4;
      • JOB_STATE_FAILED

        public static final JobState JOB_STATE_FAILED
         The job failed.
         
        JOB_STATE_FAILED = 5;
      • JOB_STATE_CANCELLING

        public static final JobState JOB_STATE_CANCELLING
         The job is being cancelled. From this state the job may only go to
         either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
         
        JOB_STATE_CANCELLING = 6;
      • JOB_STATE_CANCELLED

        public static final JobState JOB_STATE_CANCELLED
         The job has been cancelled.
         
        JOB_STATE_CANCELLED = 7;
      • JOB_STATE_PAUSED

        public static final JobState JOB_STATE_PAUSED
         The job has been stopped, and can be resumed.
         
        JOB_STATE_PAUSED = 8;
      • JOB_STATE_EXPIRED

        public static final JobState JOB_STATE_EXPIRED
         The job has expired.
         
        JOB_STATE_EXPIRED = 9;
      • JOB_STATE_UPDATING

        public static final JobState JOB_STATE_UPDATING
         The job is being updated. Only jobs in the `RUNNING` state can be updated.
         After updating, the job goes back to the `RUNNING` state.
         
        JOB_STATE_UPDATING = 10;
      • JOB_STATE_PARTIALLY_SUCCEEDED

        public static final JobState JOB_STATE_PARTIALLY_SUCCEEDED
         The job is partially succeeded, some results may be missing due to errors.
         
        JOB_STATE_PARTIALLY_SUCCEEDED = 11;
      • UNRECOGNIZED

        public static final JobState UNRECOGNIZED
    • Field Detail

      • JOB_STATE_UNSPECIFIED_VALUE

        public static final int JOB_STATE_UNSPECIFIED_VALUE
         The job state is unspecified.
         
        JOB_STATE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • JOB_STATE_QUEUED_VALUE

        public static final int JOB_STATE_QUEUED_VALUE
         The job has been just created or resumed and processing has not yet begun.
         
        JOB_STATE_QUEUED = 1;
        See Also:
        Constant Field Values
      • JOB_STATE_PENDING_VALUE

        public static final int JOB_STATE_PENDING_VALUE
         The service is preparing to run the job.
         
        JOB_STATE_PENDING = 2;
        See Also:
        Constant Field Values
      • JOB_STATE_RUNNING_VALUE

        public static final int JOB_STATE_RUNNING_VALUE
         The job is in progress.
         
        JOB_STATE_RUNNING = 3;
        See Also:
        Constant Field Values
      • JOB_STATE_SUCCEEDED_VALUE

        public static final int JOB_STATE_SUCCEEDED_VALUE
         The job completed successfully.
         
        JOB_STATE_SUCCEEDED = 4;
        See Also:
        Constant Field Values
      • JOB_STATE_FAILED_VALUE

        public static final int JOB_STATE_FAILED_VALUE
         The job failed.
         
        JOB_STATE_FAILED = 5;
        See Also:
        Constant Field Values
      • JOB_STATE_CANCELLING_VALUE

        public static final int JOB_STATE_CANCELLING_VALUE
         The job is being cancelled. From this state the job may only go to
         either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
         
        JOB_STATE_CANCELLING = 6;
        See Also:
        Constant Field Values
      • JOB_STATE_CANCELLED_VALUE

        public static final int JOB_STATE_CANCELLED_VALUE
         The job has been cancelled.
         
        JOB_STATE_CANCELLED = 7;
        See Also:
        Constant Field Values
      • JOB_STATE_PAUSED_VALUE

        public static final int JOB_STATE_PAUSED_VALUE
         The job has been stopped, and can be resumed.
         
        JOB_STATE_PAUSED = 8;
        See Also:
        Constant Field Values
      • JOB_STATE_EXPIRED_VALUE

        public static final int JOB_STATE_EXPIRED_VALUE
         The job has expired.
         
        JOB_STATE_EXPIRED = 9;
        See Also:
        Constant Field Values
      • JOB_STATE_UPDATING_VALUE

        public static final int JOB_STATE_UPDATING_VALUE
         The job is being updated. Only jobs in the `RUNNING` state can be updated.
         After updating, the job goes back to the `RUNNING` state.
         
        JOB_STATE_UPDATING = 10;
        See Also:
        Constant Field Values
      • JOB_STATE_PARTIALLY_SUCCEEDED_VALUE

        public static final int JOB_STATE_PARTIALLY_SUCCEEDED_VALUE
         The job is partially succeeded, some results may be missing due to errors.
         
        JOB_STATE_PARTIALLY_SUCCEEDED = 11;
        See Also:
        Constant Field Values
    • Method Detail

      • values

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

        public static JobState 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 JobState 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 JobState 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<JobState> 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 JobState 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