Package com.google.cloud.documentai.v1

Enum BatchProcessMetadata.State

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

  • Enum Constant Details

  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       The default value. This value is used if the state is omitted.
      STATE_UNSPECIFIED = 0;
      See Also:

    • WAITING_VALUE

      public static final int WAITING_VALUE
       Request operation is waiting for scheduling.
      WAITING = 1;
      See Also:

    • RUNNING_VALUE

      public static final int RUNNING_VALUE
       Request is being processed.
      RUNNING = 2;
      See Also:

    • SUCCEEDED_VALUE

      public static final int SUCCEEDED_VALUE
       The batch processing completed successfully.
      SUCCEEDED = 3;
      See Also:

    • CANCELLING_VALUE

      public static final int CANCELLING_VALUE
       The batch processing was being cancelled.
      CANCELLING = 4;
      See Also:

    • CANCELLED_VALUE

      public static final int CANCELLED_VALUE
       The batch processing was cancelled.
      CANCELLED = 5;
      See Also:

    • FAILED_VALUE

      public static final int FAILED_VALUE
       The batch processing has failed.
      FAILED = 6;
      See Also:

  • Method Details

    • values

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