Enum DocumentSchema.EntityType.Property.OccurrenceType (2.51.0) 

public enum DocumentSchema.EntityType.Property.OccurrenceType extends Enum<DocumentSchema.EntityType.Property.OccurrenceType> implements ProtocolMessageEnum

Types of occurrences of the entity type in the document. This represents the number of instances, not mentions, of an entity. For example, a bank statement might only have one account_number, but this account number can be mentioned in several places on the document. In this case, the account_number is 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 is set to REQUIRED_MULTIPLE.

Protobuf enum google.cloud.documentai.v1.DocumentSchema.EntityType.Property.OccurrenceType

Implements

ProtocolMessageEnum

Static Fields

Name Description
OCCURRENCE_TYPE_UNSPECIFIED

Unspecified occurrence type.

OCCURRENCE_TYPE_UNSPECIFIED = 0;
OCCURRENCE_TYPE_UNSPECIFIED_VALUE

Unspecified occurrence type.

OCCURRENCE_TYPE_UNSPECIFIED = 0;
OPTIONAL_MULTIPLE

The entity type will appear zero or multiple times.

OPTIONAL_MULTIPLE = 2;
OPTIONAL_MULTIPLE_VALUE

The entity type will appear zero or multiple times.

OPTIONAL_MULTIPLE = 2;
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_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;
REQUIRED_MULTIPLE

The entity type will appear once or more times.

REQUIRED_MULTIPLE = 4;
REQUIRED_MULTIPLE_VALUE

The entity type will appear once or more times.

REQUIRED_MULTIPLE = 4;
REQUIRED_ONCE

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

REQUIRED_ONCE = 3;
REQUIRED_ONCE_VALUE

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

REQUIRED_ONCE = 3;
UNRECOGNIZED

Static Methods

Name Description
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)

Deprecated. Use #forNumber(int) instead.
valueOf(String name)
values()

Methods

Name Description
getDescriptorForType()
getNumber()
getValueDescriptor()