Package com.google.cloud.aiplatform.v1

Enum Study.State

java.lang.Object
java.lang.Enum<Study.State>
com.google.cloud.aiplatform.v1.Study.State
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Study.State>
Enclosing class:
Study
public static enum Study.State extends Enum<Study.State> implements com.google.protobuf.ProtocolMessageEnum
 Describes the Study state.
Protobuf enum google.cloud.aiplatform.v1.Study.State

  • Enum Constant Details

    • STATE_UNSPECIFIED

      public static final Study.State STATE_UNSPECIFIED
       The study state is unspecified.
      STATE_UNSPECIFIED = 0;

    • ACTIVE

      public static final Study.State ACTIVE
       The study is active.
      ACTIVE = 1;

    • INACTIVE

      public static final Study.State INACTIVE
       The study is stopped due to an internal error.
      INACTIVE = 2;

    • COMPLETED

      public static final Study.State COMPLETED
       The study is done when the service exhausts the parameter search space
 or max_trial_count is reached.
      COMPLETED = 3;

    • UNRECOGNIZED

      public static final Study.State UNRECOGNIZED

  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       The study state is unspecified.
      STATE_UNSPECIFIED = 0;
      See Also:

    • ACTIVE_VALUE

      public static final int ACTIVE_VALUE
       The study is active.
      ACTIVE = 1;
      See Also:

    • INACTIVE_VALUE

      public static final int INACTIVE_VALUE
       The study is stopped due to an internal error.
      INACTIVE = 2;
      See Also:

    • COMPLETED_VALUE

      public static final int COMPLETED_VALUE
       The study is done when the service exhausts the parameter search space
 or max_trial_count is reached.
      COMPLETED = 3;
      See Also:

  • Method Details

    • values

      public static Study.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Study.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 Study.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 Study.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<Study.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 com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static Study.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