com.google.cloud.documentai.v1beta3

Enum DocumentSchema.EntityType.Property.OccurrenceType

java.lang.Object

java.lang.Enum<DocumentSchema.EntityType.Property.OccurrenceType>

com.google.cloud.documentai.v1beta3.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.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType

Enum Constant Summary

Enum Constants

Enum Constant and Description
OCCURRENCE_TYPE_UNSPECIFIED Unspecified occurrence type.
OPTIONAL_MULTIPLE The entity type will appear zero or multiple times.
OPTIONAL_ONCE There will be zero or one instance of this entity type.
REQUIRED_MULTIPLE The entity type will appear once or more times.
REQUIRED_ONCE The entity type will only appear exactly once.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	OCCURRENCE_TYPE_UNSPECIFIED_VALUE Unspecified occurrence type.
static int	OPTIONAL_MULTIPLE_VALUE The entity type will appear zero or multiple times.
static int	OPTIONAL_ONCE_VALUE There will be zero or one instance of this entity type.
static int	REQUIRED_MULTIPLE_VALUE The entity type will appear once or more times.
static int	REQUIRED_ONCE_VALUE The entity type will only appear exactly once.

Method Summary

Modifier and Type	Method and Description
static DocumentSchema.EntityType.Property.OccurrenceType	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<DocumentSchema.EntityType.Property.OccurrenceType>	internalGetValueMap()
static DocumentSchema.EntityType.Property.OccurrenceType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static DocumentSchema.EntityType.Property.OccurrenceType	valueOf(int value) Deprecated. Use forNumber(int) instead.
static DocumentSchema.EntityType.Property.OccurrenceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentSchema.EntityType.Property.OccurrenceType[]	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 Detail

OCCURRENCE_TYPE_UNSPECIFIED

public static final DocumentSchema.EntityType.Property.OccurrenceType OCCURRENCE_TYPE_UNSPECIFIED

 Unspecified occurrence type.
 

OCCURRENCE_TYPE_UNSPECIFIED = 0;

OPTIONAL_ONCE

public static final DocumentSchema.EntityType.Property.OccurrenceType OPTIONAL_ONCE

 There will be zero or one instance of this entity type.  The same
 entity instance may be mentioned multiple times.
 

OPTIONAL_ONCE = 1;

OPTIONAL_MULTIPLE

public static final DocumentSchema.EntityType.Property.OccurrenceType OPTIONAL_MULTIPLE

 The entity type will appear zero or multiple times.
 

OPTIONAL_MULTIPLE = 2;

REQUIRED_ONCE

public static final DocumentSchema.EntityType.Property.OccurrenceType REQUIRED_ONCE

 The entity type will only appear exactly once.  The same
 entity instance may be mentioned multiple times.
 

REQUIRED_ONCE = 3;

REQUIRED_MULTIPLE

public static final DocumentSchema.EntityType.Property.OccurrenceType REQUIRED_MULTIPLE

 The entity type will appear once or more times.
 

REQUIRED_MULTIPLE = 4;

UNRECOGNIZED

public static final DocumentSchema.EntityType.Property.OccurrenceType UNRECOGNIZED

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. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static DocumentSchema.EntityType.Property.OccurrenceType 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<DocumentSchema.EntityType.Property.OccurrenceType> 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 DocumentSchema.EntityType.Property.OccurrenceType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)