Package com.google.cloud.documentai.v1

Enum 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 Detail

      • 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;

    • Field Detail

      • STATE_UNSPECIFIED_VALUE

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

      • 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:
        Constant Field Values

      • DISABLED_VALUE

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

      • ENABLING_VALUE

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

      • DISABLING_VALUE

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

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • DELETING_VALUE

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

    • Method Detail

      • values

        public static Processor.State[] 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 (Processor.State c : Processor.State.values())
    System.out.println(c);
        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 final 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