Package com.google.cloud.documentai.v1

Enum CommonOperationMetadata.State

java.lang.Object
java.lang.Enum<CommonOperationMetadata.State>
com.google.cloud.documentai.v1.CommonOperationMetadata.State
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<CommonOperationMetadata.State>
Enclosing class:
CommonOperationMetadata
public static enum CommonOperationMetadata.State extends Enum<CommonOperationMetadata.State> implements com.google.protobuf.ProtocolMessageEnum
 State of the longrunning operation.
Protobuf enum google.cloud.documentai.v1.CommonOperationMetadata.State

  • Enum Constant Details

  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       Unspecified state.
      STATE_UNSPECIFIED = 0;
      See Also:

    • RUNNING_VALUE

      public static final int RUNNING_VALUE
       Operation is still running.
      RUNNING = 1;
      See Also:

    • CANCELLING_VALUE

      public static final int CANCELLING_VALUE
       Operation is being cancelled.
      CANCELLING = 2;
      See Also:

    • SUCCEEDED_VALUE

      public static final int SUCCEEDED_VALUE
       Operation succeeded.
      SUCCEEDED = 3;
      See Also:

    • FAILED_VALUE

      public static final int FAILED_VALUE
       Operation failed.
      FAILED = 4;
      See Also:

    • CANCELLED_VALUE

      public static final int CANCELLED_VALUE
       Operation is cancelled.
      CANCELLED = 5;
      See Also:

  • Method Details

    • values

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