Class Document.Entity.Builder (2.47.0)

public static final class Document.Entity.Builder extends GeneratedMessageV3.Builder<Document.Entity.Builder> implements Document.EntityOrBuilder

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.

Protobuf type google.cloud.documentai.v1beta2.Document.Entity

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Entity.Builder

Implements

Document.EntityOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllProperties(Iterable<? extends Document.Entity> values)

public Document.Entity.Builder addAllProperties(Iterable<? extends Document.Entity> values)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.documentai.v1beta2.Document.Entity>`

Returns
Type	Description
`Document.Entity.Builder`

addProperties(Document.Entity value)

public Document.Entity.Builder addProperties(Document.Entity value)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.Entity`

Returns
Type	Description
`Document.Entity.Builder`

addProperties(Document.Entity.Builder builderForValue)

public Document.Entity.Builder addProperties(Document.Entity.Builder builderForValue)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Document.Entity.Builder`

Returns
Type	Description
`Document.Entity.Builder`

addProperties(int index, Document.Entity value)

public Document.Entity.Builder addProperties(int index, Document.Entity value)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Document.Entity`

Returns
Type	Description
`Document.Entity.Builder`

addProperties(int index, Document.Entity.Builder builderForValue)

public Document.Entity.Builder addProperties(int index, Document.Entity.Builder builderForValue)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Document.Entity.Builder`

Returns
Type	Description
`Document.Entity.Builder`

addPropertiesBuilder()

public Document.Entity.Builder addPropertiesBuilder()

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`

addPropertiesBuilder(int index)

public Document.Entity.Builder addPropertiesBuilder(int index)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Document.Entity.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Document.Entity build()

Returns
Type	Description
`Document.Entity`

buildPartial()

public Document.Entity buildPartial()

Returns
Type	Description
`Document.Entity`

clear()

public Document.Entity.Builder clear()

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConfidence()

public Document.Entity.Builder clearConfidence()

Optional. Confidence of detected Schema entity. Range [0, 1].

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Entity.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearId()

public Document.Entity.Builder clearId()

Optional. Canonical id. This will be a unique value in the entity list for this document.

string id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

clearMentionId()

public Document.Entity.Builder clearMentionId()

Optional. Deprecated. Use id field instead.

string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

clearMentionText()

public Document.Entity.Builder clearMentionText()

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

clearNormalizedValue()

public Document.Entity.Builder clearNormalizedValue()

Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageAnchor()

public Document.Entity.Builder clearPageAnchor()

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`

clearProperties()

public Document.Entity.Builder clearProperties()

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`

clearProvenance()

public Document.Entity.Builder clearProvenance()

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`

clearRedacted()

public Document.Entity.Builder clearRedacted()

Optional. Whether the entity will be redacted for de-identification purposes.

bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

clearTextAnchor()

public Document.Entity.Builder clearTextAnchor()

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.Builder`

clearType()

public Document.Entity.Builder clearType()

Required. Entity type from a schema e.g. Address.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

clone()

public Document.Entity.Builder clone()

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getConfidence()

public float getConfidence()

Optional. Confidence of detected Schema entity. Range [0, 1].

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`float`	The confidence.

getDefaultInstanceForType()

public Document.Entity getDefaultInstanceForType()

Returns
Type	Description
`Document.Entity`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getId()

public String getId()

Optional. Canonical id. This will be a unique value in the entity list for this document.

string id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The id.

getIdBytes()

public ByteString getIdBytes()

Optional. Canonical id. This will be a unique value in the entity list for this document.

string id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for id.

getMentionId()

public String getMentionId()

Optional. Deprecated. Use id field instead.

string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The mentionId.

getMentionIdBytes()

public ByteString getMentionIdBytes()

Optional. Deprecated. Use id field instead.

string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for mentionId.

getMentionText()

public String getMentionText()

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The mentionText.

getMentionTextBytes()

public ByteString getMentionTextBytes()

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for mentionText.

getNormalizedValue()

public Document.Entity.NormalizedValue getNormalizedValue()

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.NormalizedValue`	The normalizedValue.

getNormalizedValueBuilder()

public Document.Entity.NormalizedValue.Builder getNormalizedValueBuilder()

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.NormalizedValue.Builder`

getNormalizedValueOrBuilder()

public Document.Entity.NormalizedValueOrBuilder getNormalizedValueOrBuilder()

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Entity.NormalizedValueOrBuilder`

getPageAnchor()

public Document.PageAnchor getPageAnchor()

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.PageAnchor`	The pageAnchor.

getPageAnchorBuilder()

public Document.PageAnchor.Builder getPageAnchorBuilder()

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.PageAnchor.Builder`

getPageAnchorOrBuilder()

public Document.PageAnchorOrBuilder getPageAnchorOrBuilder()

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.PageAnchorOrBuilder`

getProperties(int index)

public Document.Entity getProperties(int index)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Document.Entity`

getPropertiesBuilder(int index)

public Document.Entity.Builder getPropertiesBuilder(int index)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Document.Entity.Builder`

getPropertiesBuilderList()

public List<Document.Entity.Builder> getPropertiesBuilderList()

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Builder>`

getPropertiesCount()

public int getPropertiesCount()

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getPropertiesList()

public List<Document.Entity> getPropertiesList()

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Entity>`

getPropertiesOrBuilder(int index)

public Document.EntityOrBuilder getPropertiesOrBuilder(int index)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Document.EntityOrBuilder`

getPropertiesOrBuilderList()

public List<? extends Document.EntityOrBuilder> getPropertiesOrBuilderList()

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.cloud.documentai.v1beta2.Document.EntityOrBuilder>`

getProvenance()

public Document.Provenance getProvenance()

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Provenance`	The provenance.

getProvenanceBuilder()

public Document.Provenance.Builder getProvenanceBuilder()

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.Provenance.Builder`

getProvenanceOrBuilder()

public Document.ProvenanceOrBuilder getProvenanceOrBuilder()

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.ProvenanceOrBuilder`

getRedacted()

public boolean getRedacted()

Optional. Whether the entity will be redacted for de-identification purposes.

bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The redacted.

getTextAnchor()

public Document.TextAnchor getTextAnchor()

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.TextAnchor`	The textAnchor.

getTextAnchorBuilder()

public Document.TextAnchor.Builder getTextAnchorBuilder()

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.TextAnchor.Builder`

getTextAnchorOrBuilder()

public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Document.TextAnchorOrBuilder`

getType()

public String getType()

Required. Entity type from a schema e.g. Address.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The type.

getTypeBytes()

public ByteString getTypeBytes()

Required. Entity type from a schema e.g. Address.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for type.

hasNormalizedValue()

public boolean hasNormalizedValue()

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the normalizedValue field is set.

hasPageAnchor()

public boolean hasPageAnchor()

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the pageAnchor field is set.

hasProvenance()

public boolean hasProvenance()

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the provenance field is set.

hasTextAnchor()

public boolean hasTextAnchor()

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the textAnchor field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Document.Entity other)

public Document.Entity.Builder mergeFrom(Document.Entity other)

Parameter
Name	Description
`other`	`Document.Entity`

Returns
Type	Description
`Document.Entity.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`Document.Entity.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Document.Entity.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeNormalizedValue(Document.Entity.NormalizedValue value)

public Document.Entity.Builder mergeNormalizedValue(Document.Entity.NormalizedValue value)

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.Entity.NormalizedValue`

Returns
Type	Description
`Document.Entity.Builder`

mergePageAnchor(Document.PageAnchor value)

public Document.Entity.Builder mergePageAnchor(Document.PageAnchor value)

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.PageAnchor`

Returns
Type	Description
`Document.Entity.Builder`

mergeProvenance(Document.Provenance value)

public Document.Entity.Builder mergeProvenance(Document.Provenance value)

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.Provenance`

Returns
Type	Description
`Document.Entity.Builder`

mergeTextAnchor(Document.TextAnchor value)

public Document.Entity.Builder mergeTextAnchor(Document.TextAnchor value)

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.TextAnchor`

Returns
Type	Description
`Document.Entity.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeProperties(int index)

public Document.Entity.Builder removeProperties(int index)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Document.Entity.Builder`

setConfidence(float value)

public Document.Entity.Builder setConfidence(float value)

Optional. Confidence of detected Schema entity. Range [0, 1].

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`float` The confidence to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setId(String value)

public Document.Entity.Builder setId(String value)

Optional. Canonical id. This will be a unique value in the entity list for this document.

string id = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The id to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setIdBytes(ByteString value)

public Document.Entity.Builder setIdBytes(ByteString value)

Optional. Canonical id. This will be a unique value in the entity list for this document.

string id = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for id to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setMentionId(String value)

public Document.Entity.Builder setMentionId(String value)

Optional. Deprecated. Use id field instead.

string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The mentionId to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setMentionIdBytes(ByteString value)

public Document.Entity.Builder setMentionIdBytes(ByteString value)

Optional. Deprecated. Use id field instead.

string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for mentionId to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setMentionText(String value)

public Document.Entity.Builder setMentionText(String value)

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The mentionText to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setMentionTextBytes(ByteString value)

public Document.Entity.Builder setMentionTextBytes(ByteString value)

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for mentionText to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setNormalizedValue(Document.Entity.NormalizedValue value)

public Document.Entity.Builder setNormalizedValue(Document.Entity.NormalizedValue value)

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.Entity.NormalizedValue`

Returns
Type	Description
`Document.Entity.Builder`

setNormalizedValue(Document.Entity.NormalizedValue.Builder builderForValue)

public Document.Entity.Builder setNormalizedValue(Document.Entity.NormalizedValue.Builder builderForValue)

.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Document.Entity.NormalizedValue.Builder`

Returns
Type	Description
`Document.Entity.Builder`

setPageAnchor(Document.PageAnchor value)

public Document.Entity.Builder setPageAnchor(Document.PageAnchor value)

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.PageAnchor`

Returns
Type	Description
`Document.Entity.Builder`

setPageAnchor(Document.PageAnchor.Builder builderForValue)

public Document.Entity.Builder setPageAnchor(Document.PageAnchor.Builder builderForValue)

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Document.PageAnchor.Builder`

Returns
Type	Description
`Document.Entity.Builder`

setProperties(int index, Document.Entity value)

public Document.Entity.Builder setProperties(int index, Document.Entity value)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Document.Entity`

Returns
Type	Description
`Document.Entity.Builder`

setProperties(int index, Document.Entity.Builder builderForValue)

public Document.Entity.Builder setProperties(int index, Document.Entity.Builder builderForValue)

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

repeated .google.cloud.documentai.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Document.Entity.Builder`

Returns
Type	Description
`Document.Entity.Builder`

setProvenance(Document.Provenance value)

public Document.Entity.Builder setProvenance(Document.Provenance value)

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.Provenance`

Returns
Type	Description
`Document.Entity.Builder`

setProvenance(Document.Provenance.Builder builderForValue)

public Document.Entity.Builder setProvenance(Document.Provenance.Builder builderForValue)

Optional. The history of this annotation.

.google.cloud.documentai.v1beta2.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Document.Provenance.Builder`

Returns
Type	Description
`Document.Entity.Builder`

setRedacted(boolean value)

public Document.Entity.Builder setRedacted(boolean value)

Optional. Whether the entity will be redacted for de-identification purposes.

bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`boolean` The redacted to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

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

public Document.Entity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTextAnchor(Document.TextAnchor value)

public Document.Entity.Builder setTextAnchor(Document.TextAnchor value)

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Document.TextAnchor`

Returns
Type	Description
`Document.Entity.Builder`

setTextAnchor(Document.TextAnchor.Builder builderForValue)

public Document.Entity.Builder setTextAnchor(Document.TextAnchor.Builder builderForValue)

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Document.TextAnchor.Builder`

Returns
Type	Description
`Document.Entity.Builder`

setType(String value)

public Document.Entity.Builder setType(String value)

Required. Entity type from a schema e.g. Address.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The type to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setTypeBytes(ByteString value)

public Document.Entity.Builder setTypeBytes(ByteString value)

Required. Entity type from a schema e.g. Address.

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for type to set.

Returns
Type	Description
`Document.Entity.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Document.Entity.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)