Package com.google.cloud.documentai.v1

Enum Processor.State

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

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CREATING
    The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones).
    DELETING
    The processor is being deleted, will be removed if successful.
    DISABLED
    The processor is disabled.
    DISABLING
    The processor is being disabled, will become `DISABLED` if successful.
    ENABLED
    The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.
    ENABLING
    The processor is being enabled, will become `ENABLED` if successful.
    FAILED
    The processor failed during creation or initialization of feature dependencies.
    STATE_UNSPECIFIED
    The processor is in an unspecified state.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CREATING_VALUE
    The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones).
    static final int
    DELETING_VALUE
    The processor is being deleted, will be removed if successful.
    static final int
    DISABLED_VALUE
    The processor is disabled.
    static final int
    DISABLING_VALUE
    The processor is being disabled, will become `DISABLED` if successful.
    static final int
    ENABLED_VALUE
    The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.
    static final int
    ENABLING_VALUE
    The processor is being enabled, will become `ENABLED` if successful.
    static final int
    FAILED_VALUE
    The processor failed during creation or initialization of feature dependencies.
    static final int
    STATE_UNSPECIFIED_VALUE
    The processor is in an unspecified state.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Processor.State
    forNumber(int value)
     
    static com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<Processor.State>
    internalGetValueMap()
     
    static Processor.State
    valueOf(int value)
    Deprecated.
    static Processor.State
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this type with the specified name.
    static Processor.State
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Processor.State[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • STATE_UNSPECIFIED

      public static final Processor.State STATE_UNSPECIFIED
       The processor is in an unspecified state.
      STATE_UNSPECIFIED = 0;

    • ENABLED

      public static final Processor.State ENABLED
       The processor is enabled, i.e., has an enabled version which can
 currently serve processing requests and all the feature dependencies have
 been successfully initialized.
      ENABLED = 1;

    • DISABLED

      public static final Processor.State DISABLED
       The processor is disabled.
      DISABLED = 2;

    • ENABLING

      public static final Processor.State ENABLING
       The processor is being enabled, will become `ENABLED` if successful.
      ENABLING = 3;

    • DISABLING

      public static final Processor.State DISABLING
       The processor is being disabled, will become `DISABLED` if successful.
      DISABLING = 4;

    • CREATING

      public static final Processor.State CREATING
       The processor is being created, will become either `ENABLED` (for
 successful creation) or `FAILED` (for failed ones).
 Once a processor is in this state, it can then be used for document
 processing, but the feature dependencies of the processor might not be
 fully created yet.
      CREATING = 5;

    • FAILED

      public static final Processor.State FAILED
       The processor failed during creation or initialization of feature
 dependencies. The user should delete the processor and recreate one as
 all the functionalities of the processor are disabled.
      FAILED = 6;

    • DELETING

      public static final Processor.State DELETING
       The processor is being deleted, will be removed if successful.
      DELETING = 7;

    • UNRECOGNIZED

      public static final Processor.State UNRECOGNIZED

  • Field Details

    • STATE_UNSPECIFIED_VALUE

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

    • ENABLED_VALUE

      public static final int ENABLED_VALUE
       The processor is enabled, i.e., has an enabled version which can
 currently serve processing requests and all the feature dependencies have
 been successfully initialized.
      ENABLED = 1;
      See Also:

    • DISABLED_VALUE

      public static final int DISABLED_VALUE
       The processor is disabled.
      DISABLED = 2;
      See Also:

    • ENABLING_VALUE

      public static final int ENABLING_VALUE
       The processor is being enabled, will become `ENABLED` if successful.
      ENABLING = 3;
      See Also:

    • DISABLING_VALUE

      public static final int DISABLING_VALUE
       The processor is being disabled, will become `DISABLED` if successful.
      DISABLING = 4;
      See Also:

    • CREATING_VALUE

      public static final int CREATING_VALUE
       The processor is being created, will become either `ENABLED` (for
 successful creation) or `FAILED` (for failed ones).
 Once a processor is in this state, it can then be used for document
 processing, but the feature dependencies of the processor might not be
 fully created yet.
      CREATING = 5;
      See Also:

    • FAILED_VALUE

      public static final int FAILED_VALUE
       The processor failed during creation or initialization of feature
 dependencies. The user should delete the processor and recreate one as
 all the functionalities of the processor are disabled.
      FAILED = 6;
      See Also:

    • DELETING_VALUE

      public static final int DELETING_VALUE
       The processor is being deleted, will be removed if successful.
      DELETING = 7;
      See Also:

  • Method Details

    • values

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