Package com.google.cloud.documentai.v1

Enum Document.Entity.Method

java.lang.Object
java.lang.Enum<Document.Entity.Method>
com.google.cloud.documentai.v1.Document.Entity.Method
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Document.Entity.Method>
Enclosing class:
Document.Entity
public static enum Document.Entity.Method extends Enum<Document.Entity.Method> implements com.google.protobuf.ProtocolMessageEnum
 Specifies how the entity's value is obtained.
Protobuf enum google.cloud.documentai.v1.Document.Entity.Method

  • Enum Constant Details

    • METHOD_UNSPECIFIED

      public static final Document.Entity.Method METHOD_UNSPECIFIED
       When the method is not specified, it should be treated as `EXTRACT`.
      METHOD_UNSPECIFIED = 0;

    • EXTRACT

      public static final Document.Entity.Method EXTRACT
       The entity's value is directly extracted as-is from the document
 text.
      EXTRACT = 1;

    • DERIVE

      public static final Document.Entity.Method DERIVE
       The entity's value is derived through inference and is not
 necessarily an exact text extraction from the document.
      DERIVE = 2;

    • UNRECOGNIZED

      public static final Document.Entity.Method UNRECOGNIZED

  • Field Details

    • METHOD_UNSPECIFIED_VALUE

      public static final int METHOD_UNSPECIFIED_VALUE
       When the method is not specified, it should be treated as `EXTRACT`.
      METHOD_UNSPECIFIED = 0;
      See Also:

    • EXTRACT_VALUE

      public static final int EXTRACT_VALUE
       The entity's value is directly extracted as-is from the document
 text.
      EXTRACT = 1;
      See Also:

    • DERIVE_VALUE

      public static final int DERIVE_VALUE
       The entity's value is derived through inference and is not
 necessarily an exact text extraction from the document.
      DERIVE = 2;
      See Also:

  • Method Details

    • values

      public static Document.Entity.Method[] 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 Document.Entity.Method 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 Document.Entity.Method 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 Document.Entity.Method 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<Document.Entity.Method> 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 Document.Entity.Method 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