Interface DocumentSchema.EntityTypeOrBuilder (2.45.0)

Version 2.45.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public static interface DocumentSchema.EntityTypeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBaseTypes(int index)

public abstract String getBaseTypes(int index)

The entity type that this type is derived from. For now, one and only one should be set.

repeated string base_types = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The baseTypes at the given index.

getBaseTypesBytes(int index)

public abstract ByteString getBaseTypesBytes(int index)

The entity type that this type is derived from. For now, one and only one should be set.

repeated string base_types = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the baseTypes at the given index.

getBaseTypesCount()

public abstract int getBaseTypesCount()

The entity type that this type is derived from. For now, one and only one should be set.

repeated string base_types = 2;

Returns
Type	Description
int	The count of baseTypes.

getBaseTypesList()

public abstract List<String> getBaseTypesList()

The entity type that this type is derived from. For now, one and only one should be set.

repeated string base_types = 2;

Returns
Type	Description
List<String>	A list containing the baseTypes.

getDisplayName()

public abstract String getDisplayName()

User defined name for the type.

string display_name = 13;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

User defined name for the type.

string display_name = 13;

Returns
Type	Description
ByteString	The bytes for displayName.

getEntityTypeMetadata()

public abstract EntityTypeMetadata getEntityTypeMetadata()

Metadata for the entity type.

.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;

Returns
Type	Description
EntityTypeMetadata	The entityTypeMetadata.

getEntityTypeMetadataOrBuilder()

public abstract EntityTypeMetadataOrBuilder getEntityTypeMetadataOrBuilder()

Metadata for the entity type.

.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;

Returns
Type	Description
EntityTypeMetadataOrBuilder

getEnumValues()

public abstract DocumentSchema.EntityType.EnumValues getEnumValues()

If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the EntityType.value_ontology field and specify a list of all possible values in a value ontology file.

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;

Returns
Type	Description
DocumentSchema.EntityType.EnumValues	The enumValues.

getEnumValuesOrBuilder()

public abstract DocumentSchema.EntityType.EnumValuesOrBuilder getEnumValuesOrBuilder()

If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the EntityType.value_ontology field and specify a list of all possible values in a value ontology file.

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;

Returns
Type	Description
DocumentSchema.EntityType.EnumValuesOrBuilder

getName()

public abstract String getName()

Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used:

• Use snake_casing.
• Name matching is case-sensitive.
• Maximum 64 characters.
• Must start with a letter.
• Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character.)
• The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used:

• Use snake_casing.
• Name matching is case-sensitive.
• Maximum 64 characters.
• Must start with a letter.
• Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character.)
• The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getProperties(int index)

public abstract DocumentSchema.EntityType.Property getProperties(int index)

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
DocumentSchema.EntityType.Property

getPropertiesCount()

public abstract int getPropertiesCount()

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

Returns
Type	Description
int

getPropertiesList()

public abstract List<DocumentSchema.EntityType.Property> getPropertiesList()

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

Returns
Type	Description
List<Property>

getPropertiesOrBuilder(int index)

public abstract DocumentSchema.EntityType.PropertyOrBuilder getPropertiesOrBuilder(int index)

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
DocumentSchema.EntityType.PropertyOrBuilder

getPropertiesOrBuilderList()

public abstract List<? extends DocumentSchema.EntityType.PropertyOrBuilder> getPropertiesOrBuilderList()

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.PropertyOrBuilder>

getValueSourceCase()

public abstract DocumentSchema.EntityType.ValueSourceCase getValueSourceCase()

Returns
Type	Description
DocumentSchema.EntityType.ValueSourceCase

hasEntityTypeMetadata()

public abstract boolean hasEntityTypeMetadata()

Metadata for the entity type.

.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;

Returns
Type	Description
boolean	Whether the entityTypeMetadata field is set.

hasEnumValues()

public abstract boolean hasEnumValues()

If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the EntityType.value_ontology field and specify a list of all possible values in a value ontology file.

.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;

Returns
Type	Description
boolean	Whether the enumValues field is set.