Class DocumentSchema.EntityType (2.59.0)

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.v1beta3.DocumentSchema.EntityType

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentSchema.EntityType

Implements

DocumentSchema.EntityTypeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BASE_TYPES_FIELD_NUMBER

public static final int BASE_TYPES_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

ENTITY_TYPE_METADATA_FIELD_NUMBER

public static final int ENTITY_TYPE_METADATA_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()

Returns
Type	Description
`DocumentSchema.EntityType`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static DocumentSchema.EntityType.Builder newBuilder()

Returns
Type	Description
`DocumentSchema.EntityType.Builder`

newBuilder(DocumentSchema.EntityType prototype)

public static DocumentSchema.EntityType.Builder newBuilder(DocumentSchema.EntityType prototype)

Parameter
Name	Description
`prototype`	`DocumentSchema.EntityType`

Returns
Type	Description
`DocumentSchema.EntityType.Builder`

parseDelimitedFrom(InputStream input)

public static DocumentSchema.EntityType parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static DocumentSchema.EntityType parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static DocumentSchema.EntityType parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static DocumentSchema.EntityType parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static DocumentSchema.EntityType parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static DocumentSchema.EntityType parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.EntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentSchema.EntityType`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<DocumentSchema.EntityType> parser()

Returns
Type	Description
`Parser<EntityType>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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
`index`	`int` 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
`index`	`int` 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;

Returns
Type	Description
`ProtocolStringList`	A list containing the baseTypes.

getDefaultInstanceForType()

public DocumentSchema.EntityType getDefaultInstanceForType()

Returns
Type	Description
`DocumentSchema.EntityType`

getDescription()

public String getDescription()

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

string description = 15;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 15;

Returns
Type	Description
`ByteString`	The bytes for description.

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.

getEntityTypeMetadata()

public EntityTypeMetadata getEntityTypeMetadata()

Metadata for the entity type.

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

Returns
Type	Description
`EntityTypeMetadata`	The entityTypeMetadata.

getEntityTypeMetadataOrBuilder()

public EntityTypeMetadataOrBuilder getEntityTypeMetadataOrBuilder()

Metadata for the entity type.

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

Returns
Type	Description
`EntityTypeMetadataOrBuilder`

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

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

getEnumValuesOrBuilder()

public DocumentSchema.EntityType.EnumValuesOrBuilder getEnumValuesOrBuilder()

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

Returns
Type	Description
`DocumentSchema.EntityType.EnumValuesOrBuilder`

getName()

public 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 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()

Returns
Type	Description
`Parser<EntityType>`

Overrides

GeneratedMessageV3.getParserForType()