public static final class DocumentSchema.EntityType extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
DocumentSchema.EntityType.Builder
EntityType is the wrapper of a label of the corresponding model with
detailed attributes and limitations for entity-based processors.
|
static class |
DocumentSchema.EntityType.EnumValues
Defines the a list of enum values.
|
static interface |
DocumentSchema.EntityType.EnumValuesOrBuilder |
static class |
DocumentSchema.EntityType.Property
Defines properties that can be part of the entity type.
|
static interface |
DocumentSchema.EntityType.PropertyOrBuilder |
static class |
DocumentSchema.EntityType.ValueSourceCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BASE_TYPES_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
ENTITY_TYPE_METADATA_FIELD_NUMBER |
static int |
ENUM_VALUES_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PROPERTIES_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getBaseTypes(int index)
The entity type that this type is derived from.
|
com.google.protobuf.ByteString |
getBaseTypesBytes(int index)
The entity type that this type is derived from.
|
int |
getBaseTypesCount()
The entity type that this type is derived from.
|
com.google.protobuf.ProtocolStringList |
getBaseTypesList()
The entity type that this type is derived from.
|
static DocumentSchema.EntityType |
getDefaultInstance() |
DocumentSchema.EntityType |
getDefaultInstanceForType() |
String |
getDescription()
The description of the entity type.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
The description of the entity type.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
User defined name for the type.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
User defined name for the type.
|
EntityTypeMetadata |
getEntityTypeMetadata()
Metadata for the entity type.
|
EntityTypeMetadataOrBuilder |
getEntityTypeMetadataOrBuilder()
Metadata for the entity type.
|
DocumentSchema.EntityType.EnumValues |
getEnumValues()
If specified, lists all the possible values for this entity.
|
DocumentSchema.EntityType.EnumValuesOrBuilder |
getEnumValuesOrBuilder()
If specified, lists all the possible values for this entity.
|
String |
getName()
Name of the type.
|
com.google.protobuf.ByteString |
getNameBytes()
Name of the type.
|
com.google.protobuf.Parser<DocumentSchema.EntityType> |
getParserForType() |
DocumentSchema.EntityType.Property |
getProperties(int index)
Description the nested structure, or composition of an entity.
|
int |
getPropertiesCount()
Description the nested structure, or composition of an entity.
|
List<DocumentSchema.EntityType.Property> |
getPropertiesList()
Description the nested structure, or composition of an entity.
|
DocumentSchema.EntityType.PropertyOrBuilder |
getPropertiesOrBuilder(int index)
Description the nested structure, or composition of an entity.
|
List<? extends DocumentSchema.EntityType.PropertyOrBuilder> |
getPropertiesOrBuilderList()
Description the nested structure, or composition of an entity.
|
int |
getSerializedSize() |
DocumentSchema.EntityType.ValueSourceCase |
getValueSourceCase() |
boolean |
hasEntityTypeMetadata()
Metadata for the entity type.
|
boolean |
hasEnumValues()
If specified, lists all the possible values for this entity.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DocumentSchema.EntityType.Builder |
newBuilder() |
static DocumentSchema.EntityType.Builder |
newBuilder(DocumentSchema.EntityType prototype) |
DocumentSchema.EntityType.Builder |
newBuilderForType() |
protected DocumentSchema.EntityType.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static DocumentSchema.EntityType |
parseDelimitedFrom(InputStream input) |
static DocumentSchema.EntityType |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentSchema.EntityType |
parseFrom(byte[] data) |
static DocumentSchema.EntityType |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentSchema.EntityType |
parseFrom(ByteBuffer data) |
static DocumentSchema.EntityType |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentSchema.EntityType |
parseFrom(com.google.protobuf.ByteString data) |
static DocumentSchema.EntityType |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentSchema.EntityType |
parseFrom(com.google.protobuf.CodedInputStream input) |
static DocumentSchema.EntityType |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentSchema.EntityType |
parseFrom(InputStream input) |
static DocumentSchema.EntityType |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<DocumentSchema.EntityType> |
parser() |
DocumentSchema.EntityType.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int ENUM_VALUES_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int BASE_TYPES_FIELD_NUMBER
public static final int PROPERTIES_FIELD_NUMBER
public static final int ENTITY_TYPE_METADATA_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public DocumentSchema.EntityType.ValueSourceCase getValueSourceCase()
getValueSourceCase in interface DocumentSchema.EntityTypeOrBuilderpublic 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;
hasEnumValues in interface DocumentSchema.EntityTypeOrBuilderpublic 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;
getEnumValues in interface DocumentSchema.EntityTypeOrBuilderpublic 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;
getEnumValuesOrBuilder in interface DocumentSchema.EntityTypeOrBuilderpublic String getDisplayName()
User defined name for the type.
string display_name = 13;getDisplayName in interface DocumentSchema.EntityTypeOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
User defined name for the type.
string display_name = 13;getDisplayNameBytes in interface DocumentSchema.EntityTypeOrBuilderpublic 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;getName in interface DocumentSchema.EntityTypeOrBuilderpublic com.google.protobuf.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;getNameBytes in interface DocumentSchema.EntityTypeOrBuilderpublic 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;getDescription in interface DocumentSchema.EntityTypeOrBuilderpublic com.google.protobuf.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;getDescriptionBytes in interface DocumentSchema.EntityTypeOrBuilderpublic com.google.protobuf.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;getBaseTypesList in interface DocumentSchema.EntityTypeOrBuilderpublic 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;getBaseTypesCount in interface DocumentSchema.EntityTypeOrBuilderpublic 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;getBaseTypes in interface DocumentSchema.EntityTypeOrBuilderindex - The index of the element to return.public com.google.protobuf.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;getBaseTypesBytes in interface DocumentSchema.EntityTypeOrBuilderindex - The index of the value to return.public List<DocumentSchema.EntityType.Property> getPropertiesList()
Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
getPropertiesList in interface DocumentSchema.EntityTypeOrBuilderpublic 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;
getPropertiesOrBuilderList in interface DocumentSchema.EntityTypeOrBuilderpublic int getPropertiesCount()
Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
getPropertiesCount in interface DocumentSchema.EntityTypeOrBuilderpublic 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;
getProperties in interface DocumentSchema.EntityTypeOrBuilderpublic 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;
getPropertiesOrBuilder in interface DocumentSchema.EntityTypeOrBuilderpublic boolean hasEntityTypeMetadata()
Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;hasEntityTypeMetadata in interface DocumentSchema.EntityTypeOrBuilderpublic EntityTypeMetadata getEntityTypeMetadata()
Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;getEntityTypeMetadata in interface DocumentSchema.EntityTypeOrBuilderpublic EntityTypeMetadataOrBuilder getEntityTypeMetadataOrBuilder()
Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;getEntityTypeMetadataOrBuilder in interface DocumentSchema.EntityTypeOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static DocumentSchema.EntityType parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DocumentSchema.EntityType parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DocumentSchema.EntityType parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DocumentSchema.EntityType parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DocumentSchema.EntityType parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DocumentSchema.EntityType parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DocumentSchema.EntityType parseFrom(InputStream input) throws IOException
IOExceptionpublic static DocumentSchema.EntityType parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DocumentSchema.EntityType parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static DocumentSchema.EntityType parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DocumentSchema.EntityType parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static DocumentSchema.EntityType parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic DocumentSchema.EntityType.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static DocumentSchema.EntityType.Builder newBuilder()
public static DocumentSchema.EntityType.Builder newBuilder(DocumentSchema.EntityType prototype)
public DocumentSchema.EntityType.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected DocumentSchema.EntityType.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static DocumentSchema.EntityType getDefaultInstance()
public static com.google.protobuf.Parser<DocumentSchema.EntityType> parser()
public com.google.protobuf.Parser<DocumentSchema.EntityType> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public DocumentSchema.EntityType getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.