Class DocumentSchema.EntityType.Builder (2.37.0)

public static final class DocumentSchema.EntityType.Builder extends GeneratedMessageV3.Builder<DocumentSchema.EntityType.Builder> 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The baseTypes to add.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityType.Property>
Returns
TypeDescription
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
NameDescription
valueString

The baseTypes to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the baseTypes to add.

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

Parameter
NameDescription
valueDocumentSchema.EntityType.Property
Returns
TypeDescription
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.v1.DocumentSchema.EntityType.Property properties = 6;

Parameter
NameDescription
builderForValueDocumentSchema.EntityType.Property.Builder
Returns
TypeDescription
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.v1.DocumentSchema.EntityType.Property properties = 6;

Parameters
NameDescription
indexint
valueDocumentSchema.EntityType.Property
Returns
TypeDescription
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.v1.DocumentSchema.EntityType.Property properties = 6;

Parameters
NameDescription
indexint
builderForValueDocumentSchema.EntityType.Property.Builder
Returns
TypeDescription
DocumentSchema.EntityType.Builder

addPropertiesBuilder()

public DocumentSchema.EntityType.Property.Builder addPropertiesBuilder()

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType.Property properties = 6;

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DocumentSchema.EntityType.Property.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentSchema.EntityType.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

build()

public DocumentSchema.EntityType build()
Returns
TypeDescription
DocumentSchema.EntityType

buildPartial()

public DocumentSchema.EntityType buildPartial()
Returns
TypeDescription
DocumentSchema.EntityType

clear()

public DocumentSchema.EntityType.Builder clear()
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

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
TypeDescription
DocumentSchema.EntityType.Builder

This builder for chaining.

clearDisplayName()

public DocumentSchema.EntityType.Builder clearDisplayName()

User defined name for the type.

string display_name = 13;

Returns
TypeDescription
DocumentSchema.EntityType.Builder

This builder for chaining.

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

Returns
TypeDescription
DocumentSchema.EntityType.Builder

clearField(Descriptors.FieldDescriptor field)

public DocumentSchema.EntityType.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

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 example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.

string name = 1;

Returns
TypeDescription
DocumentSchema.EntityType.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentSchema.EntityType.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

clearProperties()

public DocumentSchema.EntityType.Builder clearProperties()

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType.Property properties = 6;

Returns
TypeDescription
DocumentSchema.EntityType.Builder

clearValueSource()

public DocumentSchema.EntityType.Builder clearValueSource()
Returns
TypeDescription
DocumentSchema.EntityType.Builder

clone()

public DocumentSchema.EntityType.Builder clone()
Returns
TypeDescription
DocumentSchema.EntityType.Builder
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the baseTypes.

getDefaultInstanceForType()

public DocumentSchema.EntityType getDefaultInstanceForType()
Returns
TypeDescription
DocumentSchema.EntityType

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

User defined name for the type.

string display_name = 13;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

User defined name for the type.

string display_name = 13;

Returns
TypeDescription
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;

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

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.DocumentSchema.EntityType.Property properties = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.DocumentSchema.EntityType.Property properties = 6;

Returns
TypeDescription
List<Builder>

getPropertiesCount()

public int getPropertiesCount()

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType.Property properties = 6;

Returns
TypeDescription
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;

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DocumentSchema.EntityType.PropertyOrBuilder

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
TypeDescription
List<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityType.PropertyOrBuilder>

getValueSourceCase()

public DocumentSchema.EntityType.ValueSourceCase getValueSourceCase()
Returns
TypeDescription
DocumentSchema.EntityType.ValueSourceCase

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
TypeDescription
boolean

Whether the enumValues field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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

Parameter
NameDescription
valueDocumentSchema.EntityType.EnumValues
Returns
TypeDescription
DocumentSchema.EntityType.Builder

mergeFrom(DocumentSchema.EntityType other)

public DocumentSchema.EntityType.Builder mergeFrom(DocumentSchema.EntityType other)
Parameter
NameDescription
otherDocumentSchema.EntityType
Returns
TypeDescription
DocumentSchema.EntityType.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentSchema.EntityType.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DocumentSchema.EntityType.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.EntityType.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

removeProperties(int index)

public DocumentSchema.EntityType.Builder removeProperties(int index)

Description the nested structure, or composition of an entity.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType.Property properties = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The baseTypes to set.

Returns
TypeDescription
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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
DocumentSchema.EntityType.Builder

This builder for chaining.

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

Parameter
NameDescription
valueDocumentSchema.EntityType.EnumValues
Returns
TypeDescription
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.v1.DocumentSchema.EntityType.EnumValues enum_values = 14;

Parameter
NameDescription
builderForValueDocumentSchema.EntityType.EnumValues.Builder
Returns
TypeDescription
DocumentSchema.EntityType.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentSchema.EntityType.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

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 example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
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 example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

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

Parameters
NameDescription
indexint
valueDocumentSchema.EntityType.Property
Returns
TypeDescription
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.v1.DocumentSchema.EntityType.Property properties = 6;

Parameters
NameDescription
indexint
builderForValueDocumentSchema.EntityType.Property.Builder
Returns
TypeDescription
DocumentSchema.EntityType.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DocumentSchema.EntityType.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentSchema.EntityType.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DocumentSchema.EntityType.Builder
Overrides