- 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 final class DocumentSchema.EntityType.Builder extends GeneratedMessageV3.Builder<DocumentSchema.EntityType.Builder> implements DocumentSchema.EntityTypeOrBuilderEntityType 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentSchema.EntityType.BuilderImplements
DocumentSchema.EntityTypeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllBaseTypes(Iterable<String> values)
public DocumentSchema.EntityType.Builder addAllBaseTypes(Iterable<String> values)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 |
values |
Iterable<String>The baseTypes to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
addAllProperties(Iterable<? extends DocumentSchema.EntityType.Property> values)
public DocumentSchema.EntityType.Builder addAllProperties(Iterable<? extends DocumentSchema.EntityType.Property> values)Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property> |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
addBaseTypes(String value)
public DocumentSchema.EntityType.Builder addBaseTypes(String value)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 |
value |
StringThe baseTypes to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
addBaseTypesBytes(ByteString value)
public DocumentSchema.EntityType.Builder addBaseTypesBytes(ByteString value)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 |
value |
ByteStringThe bytes of the baseTypes to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
addProperties(DocumentSchema.EntityType.Property value)
public DocumentSchema.EntityType.Builder addProperties(DocumentSchema.EntityType.Property value)Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
DocumentSchema.EntityType.Property |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
addProperties(DocumentSchema.EntityType.Property.Builder builderForValue)
public DocumentSchema.EntityType.Builder addProperties(DocumentSchema.EntityType.Property.Builder builderForValue)Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DocumentSchema.EntityType.Property.Builder |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
addProperties(int index, DocumentSchema.EntityType.Property value)
public DocumentSchema.EntityType.Builder addProperties(int index, DocumentSchema.EntityType.Property value)Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DocumentSchema.EntityType.Property |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
addProperties(int index, DocumentSchema.EntityType.Property.Builder builderForValue)
public DocumentSchema.EntityType.Builder addProperties(int index, DocumentSchema.EntityType.Property.Builder builderForValue)Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DocumentSchema.EntityType.Property.Builder |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
addPropertiesBuilder()
public DocumentSchema.EntityType.Property.Builder addPropertiesBuilder()Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Property.Builder |
|
addPropertiesBuilder(int index)
public DocumentSchema.EntityType.Property.Builder addPropertiesBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentSchema.EntityType.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
build()
public DocumentSchema.EntityType build()| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType |
|
buildPartial()
public DocumentSchema.EntityType buildPartial()| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType |
|
clear()
public DocumentSchema.EntityType.Builder clear()| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
clearBaseTypes()
public DocumentSchema.EntityType.Builder clearBaseTypes()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 |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
clearDescription()
public DocumentSchema.EntityType.Builder clearDescription()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 |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
clearDisplayName()
public DocumentSchema.EntityType.Builder clearDisplayName()User defined name for the type.
string display_name = 13;
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
clearEntityTypeMetadata()
public DocumentSchema.EntityType.Builder clearEntityTypeMetadata()Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
clearEnumValues()
public DocumentSchema.EntityType.Builder clearEnumValues() 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.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public DocumentSchema.EntityType.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
clearName()
public DocumentSchema.EntityType.Builder clearName()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 exampleline_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DocumentSchema.EntityType.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
clearProperties()
public DocumentSchema.EntityType.Builder clearProperties()Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
clearValueSource()
public DocumentSchema.EntityType.Builder clearValueSource()| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
clone()
public DocumentSchema.EntityType.Builder clone()| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
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 |
intThe 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 |
intThe 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getEntityTypeMetadataBuilder()
public EntityTypeMetadata.Builder getEntityTypeMetadataBuilder()Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;
| Returns | |
|---|---|
| Type | Description |
EntityTypeMetadata.Builder |
|
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. |
getEnumValuesBuilder()
public DocumentSchema.EntityType.EnumValues.Builder getEnumValuesBuilder() 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.Builder |
|
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.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 exampleline_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 exampleline_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 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 |
|
getPropertiesBuilder(int index)
public DocumentSchema.EntityType.Property.Builder getPropertiesBuilder(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.Builder |
|
getPropertiesBuilderList()
public List<DocumentSchema.EntityType.Property.Builder> getPropertiesBuilderList()Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getPropertiesCount()
public 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 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 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 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 DocumentSchema.EntityType.ValueSourceCase getValueSourceCase()| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.ValueSourceCase |
|
hasEntityTypeMetadata()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEntityTypeMetadata(EntityTypeMetadata value)
public DocumentSchema.EntityType.Builder mergeEntityTypeMetadata(EntityTypeMetadata value)Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
EntityTypeMetadata |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
mergeEnumValues(DocumentSchema.EntityType.EnumValues value)
public DocumentSchema.EntityType.Builder mergeEnumValues(DocumentSchema.EntityType.EnumValues value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
DocumentSchema.EntityType.EnumValues |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
mergeFrom(DocumentSchema.EntityType other)
public DocumentSchema.EntityType.Builder mergeFrom(DocumentSchema.EntityType other)| Parameter | |
|---|---|
| Name | Description |
other |
DocumentSchema.EntityType |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DocumentSchema.EntityType.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DocumentSchema.EntityType.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentSchema.EntityType.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
removeProperties(int index)
public DocumentSchema.EntityType.Builder removeProperties(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.Builder |
|
setBaseTypes(int index, String value)
public DocumentSchema.EntityType.Builder setBaseTypes(int index, String value)The entity type that this type is derived from. For now, one and only one should be set.
repeated string base_types = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe baseTypes to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
setDescription(String value)
public DocumentSchema.EntityType.Builder setDescription(String value)The description of the entity type. Could be used to provide more information about the entity type for model calls.
string description = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public DocumentSchema.EntityType.Builder setDescriptionBytes(ByteString value)The description of the entity type. Could be used to provide more information about the entity type for model calls.
string description = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
setDisplayName(String value)
public DocumentSchema.EntityType.Builder setDisplayName(String value)User defined name for the type.
string display_name = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public DocumentSchema.EntityType.Builder setDisplayNameBytes(ByteString value)User defined name for the type.
string display_name = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
setEntityTypeMetadata(EntityTypeMetadata value)
public DocumentSchema.EntityType.Builder setEntityTypeMetadata(EntityTypeMetadata value)Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
EntityTypeMetadata |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setEntityTypeMetadata(EntityTypeMetadata.Builder builderForValue)
public DocumentSchema.EntityType.Builder setEntityTypeMetadata(EntityTypeMetadata.Builder builderForValue)Metadata for the entity type.
.google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EntityTypeMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setEnumValues(DocumentSchema.EntityType.EnumValues value)
public DocumentSchema.EntityType.Builder setEnumValues(DocumentSchema.EntityType.EnumValues value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
DocumentSchema.EntityType.EnumValues |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setEnumValues(DocumentSchema.EntityType.EnumValues.Builder builderForValue)
public DocumentSchema.EntityType.Builder setEnumValues(DocumentSchema.EntityType.EnumValues.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DocumentSchema.EntityType.EnumValues.Builder |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentSchema.EntityType.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setName(String value)
public DocumentSchema.EntityType.Builder setName(String value)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 exampleline_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public DocumentSchema.EntityType.Builder setNameBytes(ByteString value)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 exampleline_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
This builder for chaining. |
setProperties(int index, DocumentSchema.EntityType.Property value)
public DocumentSchema.EntityType.Builder setProperties(int index, DocumentSchema.EntityType.Property value)Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DocumentSchema.EntityType.Property |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setProperties(int index, DocumentSchema.EntityType.Property.Builder builderForValue)
public DocumentSchema.EntityType.Builder setProperties(int index, DocumentSchema.EntityType.Property.Builder builderForValue)Description the nested structure, or composition of an entity.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DocumentSchema.EntityType.Property.Builder |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentSchema.EntityType.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentSchema.EntityType.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentSchema.EntityType.Builder |
|