Interface DocumentSchema.EntityTypeOrBuilder (2.16.0)

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.

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.v1.DocumentSchema.EntityType.EnumValues enum_values = 14;

Returns

Type	Description
`DocumentSchema.EntityType.EnumValues`	The enumValues.

getEnumValuesOrBuilder()

public abstract DocumentSchema.EntityType.EnumValuesOrBuilder getEnumValuesOrBuilder()

.google.cloud.documentai.v1.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'. Besides that we use the following naming conventions:

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'. Besides that we use the following naming conventions:

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.v1.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.v1.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.v1.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.v1.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.v1.DocumentSchema.EntityType.Property properties = 6;

Returns

Type	Description
`List<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityType.PropertyOrBuilder>`

getValueSourceCase()

public abstract DocumentSchema.EntityType.ValueSourceCase getValueSourceCase()

Returns

Type	Description
`DocumentSchema.EntityType.ValueSourceCase`

hasEnumValues()

public abstract boolean hasEnumValues()

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

Returns

Type	Description
`boolean`	Whether the enumValues field is set.