Send feedback
Class DocumentSchema.EntityType (2.32.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.32.0keyboard_arrow_down
public static final class DocumentSchema . EntityType extends GeneratedMessageV3 implements DocumentSchema . EntityTypeOrBuilder
EntityType is the wrapper of a label of the corresponding model with
detailed attributes and limitations for entity-based processors. Multiple
types can also compose a dependency tree to represent nested types.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
BASE_TYPES_FIELD_NUMBER
public static final int BASE_TYPES_FIELD_NUMBER
Field Value
Type Description
int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
ENUM_VALUES_FIELD_NUMBER
public static final int ENUM_VALUES_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
PROPERTIES_FIELD_NUMBER
public static final int PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static DocumentSchema . EntityType getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DocumentSchema . EntityType . Builder newBuilder ()
newBuilder(DocumentSchema.EntityType prototype)
public static DocumentSchema . EntityType . Builder newBuilder ( DocumentSchema . EntityType prototype )
public static DocumentSchema . EntityType parseDelimitedFrom ( InputStream input )
public static DocumentSchema . EntityType parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DocumentSchema . EntityType parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema . EntityType parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DocumentSchema . EntityType parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema . EntityType parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DocumentSchema . EntityType parseFrom ( CodedInputStream input )
public static DocumentSchema . EntityType parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DocumentSchema . EntityType parseFrom ( InputStream input )
public static DocumentSchema . EntityType parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DocumentSchema . EntityType parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema . EntityType parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DocumentSchema . EntityType > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getBaseTypes(int index)
public 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
indexint The index of the element to return.
Returns
Type Description
String The baseTypes at the given index.
getBaseTypesBytes(int index)
public 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
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the baseTypes at the given index.
getBaseTypesCount()
public 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 ProtocolStringList getBaseTypesList ()
The entity type that this type is derived from. For now, one and only
one should be set.
repeated string base_types = 2;
getDefaultInstanceForType()
public DocumentSchema . EntityType getDefaultInstanceForType ()
getDisplayName()
public String getDisplayName ()
User defined name for the type.
string display_name = 13;
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
User defined name for the type.
string display_name = 13;
Returns
Type Description
ByteString The bytes for displayName.
getEnumValues()
public 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;
getEnumValuesOrBuilder()
public 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.v1.DocumentSchema.EntityType.EnumValues enum_values = 14;
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 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.
getParserForType()
public Parser<DocumentSchema . EntityType > getParserForType ()
Overrides
getProperties(int index)
public 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
indexint
getPropertiesCount()
public 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 List<DocumentSchema . EntityType . Property > getPropertiesList ()
Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1.DocumentSchema.EntityType.Property properties = 6;
getPropertiesOrBuilder(int index)
public 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
indexint
getPropertiesOrBuilderList()
public 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 >
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getValueSourceCase()
public DocumentSchema . EntityType . ValueSourceCase getValueSourceCase ()
hasEnumValues()
public 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.v1.DocumentSchema.EntityType.EnumValues enum_values = 14;
Returns
Type Description
boolean Whether the enumValues field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DocumentSchema . EntityType . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentSchema . EntityType . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public DocumentSchema . EntityType . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
