Class Document.Entity.Builder (2.20.0)

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

A phrase in the text that is a known entity type, such as a person, an organization, or location.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Document.Entity build()
Returns
TypeDescription
Document.Entity

buildPartial()

public Document.Entity buildPartial()
Returns
TypeDescription
Document.Entity

clear()

public Document.Entity.Builder clear()
Returns
TypeDescription
Document.Entity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Document.Entity.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Document.Entity.Builder
Overrides

clearMentionId()

public Document.Entity.Builder clearMentionId()

Canonical mention name. This will be a unique value in the entity list for this document.

string mention_id = 4;

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

clearMentionText()

public Document.Entity.Builder clearMentionText()

Text value in the document e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3;

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Document.Entity.Builder
Overrides

clearTextAnchor()

public Document.Entity.Builder clearTextAnchor()

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
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
TypeDescription
Document.Entity.Builder

This builder for chaining.

clone()

public Document.Entity.Builder clone()
Returns
TypeDescription
Document.Entity.Builder
Overrides

getDefaultInstanceForType()

public Document.Entity getDefaultInstanceForType()
Returns
TypeDescription
Document.Entity

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMentionId()

public String getMentionId()

Canonical mention name. This will be a unique value in the entity list for this document.

string mention_id = 4;

Returns
TypeDescription
String

The mentionId.

getMentionIdBytes()

public ByteString getMentionIdBytes()

Canonical mention name. This will be a unique value in the entity list for this document.

string mention_id = 4;

Returns
TypeDescription
ByteString

The bytes for mentionId.

getMentionText()

public String getMentionText()

Text value in the document e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3;

Returns
TypeDescription
String

The mentionText.

getMentionTextBytes()

public ByteString getMentionTextBytes()

Text value in the document e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3;

Returns
TypeDescription
ByteString

The bytes for mentionText.

getTextAnchor()

public Document.TextAnchor getTextAnchor()

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
Document.TextAnchor

The textAnchor.

getTextAnchorBuilder()

public Document.TextAnchor.Builder getTextAnchorBuilder()

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
Document.TextAnchor.Builder

getTextAnchorOrBuilder()

public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
Document.TextAnchorOrBuilder

getType()

public String getType()

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

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

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

The bytes for type.

hasTextAnchor()

public boolean hasTextAnchor()

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
boolean

Whether the textAnchor field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Document.Entity other)

public Document.Entity.Builder mergeFrom(Document.Entity other)
Parameter
NameDescription
otherDocument.Entity
Returns
TypeDescription
Document.Entity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Document.Entity.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Document.Entity.Builder
Overrides

mergeTextAnchor(Document.TextAnchor value)

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

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Parameter
NameDescription
valueDocument.TextAnchor
Returns
TypeDescription
Document.Entity.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Entity.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setMentionId(String value)

public Document.Entity.Builder setMentionId(String value)

Canonical mention name. This will be a unique value in the entity list for this document.

string mention_id = 4;

Parameter
NameDescription
valueString

The mentionId to set.

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

setMentionIdBytes(ByteString value)

public Document.Entity.Builder setMentionIdBytes(ByteString value)

Canonical mention name. This will be a unique value in the entity list for this document.

string mention_id = 4;

Parameter
NameDescription
valueByteString

The bytes for mentionId to set.

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

setMentionText(String value)

public Document.Entity.Builder setMentionText(String value)

Text value in the document e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3;

Parameter
NameDescription
valueString

The mentionText to set.

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

setMentionTextBytes(ByteString value)

public Document.Entity.Builder setMentionTextBytes(ByteString value)

Text value in the document e.g. 1600 Amphitheatre Pkwy.

string mention_text = 3;

Parameter
NameDescription
valueByteString

The bytes for mentionText to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Document.Entity.Builder
Overrides

setTextAnchor(Document.TextAnchor value)

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

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Parameter
NameDescription
valueDocument.TextAnchor
Returns
TypeDescription
Document.Entity.Builder

setTextAnchor(Document.TextAnchor.Builder builderForValue)

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

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

.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;

Parameter
NameDescription
builderForValueDocument.TextAnchor.Builder
Returns
TypeDescription
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
NameDescription
valueString

The type to set.

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

The bytes for type to set.

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Entity.Builder
Overrides