Interface DocumentSchema.EntityType.PropertyOrBuilder (2.58.0)

public static interface DocumentSchema.EntityType.PropertyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

The description of the property. Could be used to provide more information about the property for model calls.

string description = 7;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

The description of the property. Could be used to provide more information about the property for model calls.

string description = 7;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

User defined name for the property.

string display_name = 6;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

User defined name for the property.

string display_name = 6;

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public abstract String getName()

The name of the property. Follows the same guidelines as the EntityType name.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of the property. Follows the same guidelines as the EntityType name.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOccurrenceType()

public abstract DocumentSchema.EntityType.Property.OccurrenceType getOccurrenceType()

Occurrence type limits the number of instances an entity type appears in the document.

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Returns
Type Description
DocumentSchema.EntityType.Property.OccurrenceType

The occurrenceType.

getOccurrenceTypeValue()

public abstract int getOccurrenceTypeValue()

Occurrence type limits the number of instances an entity type appears in the document.

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for occurrenceType.

getPropertyMetadata()

public abstract PropertyMetadata getPropertyMetadata()

Any additional metadata about the property can be added here.

.google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;

Returns
Type Description
PropertyMetadata

The propertyMetadata.

getPropertyMetadataOrBuilder()

public abstract PropertyMetadataOrBuilder getPropertyMetadataOrBuilder()

Any additional metadata about the property can be added here.

.google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;

Returns
Type Description
PropertyMetadataOrBuilder

getValueType()

public abstract String getValueType()

A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

string value_type = 2;

Returns
Type Description
String

The valueType.

getValueTypeBytes()

public abstract ByteString getValueTypeBytes()

A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

string value_type = 2;

Returns
Type Description
ByteString

The bytes for valueType.

hasPropertyMetadata()

public abstract boolean hasPropertyMetadata()

Any additional metadata about the property can be added here.

.google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;

Returns
Type Description
boolean

Whether the propertyMetadata field is set.