Package com.google.cloud.documentai.v1

Enum DocumentSchema.EntityType.Property.OccurrenceType

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<DocumentSchema.EntityType.Property.OccurrenceType>
    Enclosing class:
    DocumentSchema.EntityType.Property
    public static enum DocumentSchema.EntityType.Property.OccurrenceType
extends Enum<DocumentSchema.EntityType.Property.OccurrenceType>
implements com.google.protobuf.ProtocolMessageEnum
     Types of occurrences of the entity type in the document.  This
 represents the number of instances of instances of an entity, not
 number of mentions of an entity.  For example, a bank statement may
 only have one `account_number`, but this account number may be
 mentioned in several places on the document.  In this case the
 'account_number' would be considered a `REQUIRED_ONCE` entity type. If,
 on the other hand, we expect a bank statement to contain the status of
 multiple different accounts for the customers, the occurrence type will
 be set to `REQUIRED_MULTIPLE`.
    Protobuf enum google.cloud.documentai.v1.DocumentSchema.EntityType.Property.OccurrenceType

    • Field Detail

      • OCCURRENCE_TYPE_UNSPECIFIED_VALUE

        public static final int OCCURRENCE_TYPE_UNSPECIFIED_VALUE
         Unspecified occurrence type.
        OCCURRENCE_TYPE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • OPTIONAL_ONCE_VALUE

        public static final int OPTIONAL_ONCE_VALUE
         There will be zero or one instance of this entity type.  The same
 entity instance may be mentioned multiple times.
        OPTIONAL_ONCE = 1;
        See Also:
        Constant Field Values

      • OPTIONAL_MULTIPLE_VALUE

        public static final int OPTIONAL_MULTIPLE_VALUE
         The entity type will appear zero or multiple times.
        OPTIONAL_MULTIPLE = 2;
        See Also:
        Constant Field Values

      • REQUIRED_ONCE_VALUE

        public static final int REQUIRED_ONCE_VALUE
         The entity type will only appear exactly once.  The same
 entity instance may be mentioned multiple times.
        REQUIRED_ONCE = 3;
        See Also:
        Constant Field Values

      • REQUIRED_MULTIPLE_VALUE

        public static final int REQUIRED_MULTIPLE_VALUE
         The entity type will appear once or more times.
        REQUIRED_MULTIPLE = 4;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static DocumentSchema.EntityType.Property.OccurrenceType[] 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 (DocumentSchema.EntityType.Property.OccurrenceType c : DocumentSchema.EntityType.Property.OccurrenceType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DocumentSchema.EntityType.Property.OccurrenceType 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 DocumentSchema.EntityType.Property.OccurrenceType 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

      • 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 DocumentSchema.EntityType.Property.OccurrenceType 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