Class Document.Entity.Builder (2.4.3)

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.v1beta2.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

clearBoundingPolyForDemoFrontend()

public Document.Entity.Builder clearBoundingPolyForDemoFrontend()

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Document.Entity.Builder

clearConfidence()

public Document.Entity.Builder clearConfidence()

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

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

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

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

This builder for chaining.

clearMentionId()

public Document.Entity.Builder clearMentionId()

Deprecated. Use id field instead.

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

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

clearTextAnchor()

public Document.Entity.Builder clearTextAnchor()

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

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

Returns
TypeDescription
Document.Entity.Builder

clearType()

public Document.Entity.Builder clearType()

Entity type from a schema e.g. Address.

string type = 2;

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

clone()

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

getBoundingPolyForDemoFrontend()

public BoundingPoly getBoundingPolyForDemoFrontend()

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
BoundingPoly

The boundingPolyForDemoFrontend.

getBoundingPolyForDemoFrontendBuilder()

public BoundingPoly.Builder getBoundingPolyForDemoFrontendBuilder()

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
BoundingPoly.Builder

getBoundingPolyForDemoFrontendOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyForDemoFrontendOrBuilder()

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

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

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

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

The bytes for id.

getMentionId()

public String getMentionId()

Deprecated. Use id field instead.

string mention_id = 4;

Returns
TypeDescription
String

The mentionId.

getMentionIdBytes()

public ByteString getMentionIdBytes()

Deprecated. Use id field instead.

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.

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
TypeDescription
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
TypeDescription
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
TypeDescription
Document.PageAnchorOrBuilder

getTextAnchor()

public Document.TextAnchor getTextAnchor()

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

.google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
Document.TextAnchorOrBuilder

getType()

public String getType()

Entity type from a schema e.g. Address.

string type = 2;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Entity type from a schema e.g. Address.

string type = 2;

Returns
TypeDescription
ByteString

The bytes for type.

hasBoundingPolyForDemoFrontend()

public boolean hasBoundingPolyForDemoFrontend()

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the boundingPolyForDemoFrontend 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
TypeDescription
boolean

Whether the pageAnchor field is set.

hasTextAnchor()

public boolean hasTextAnchor()

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

.google.cloud.documentai.v1beta2.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

mergeBoundingPolyForDemoFrontend(BoundingPoly value)

public Document.Entity.Builder mergeBoundingPolyForDemoFrontend(BoundingPoly value)

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Document.Entity.Builder

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

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

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.v1beta2.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

setBoundingPolyForDemoFrontend(BoundingPoly value)

public Document.Entity.Builder setBoundingPolyForDemoFrontend(BoundingPoly value)

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Document.Entity.Builder

setBoundingPolyForDemoFrontend(BoundingPoly.Builder builderForValue)

public Document.Entity.Builder setBoundingPolyForDemoFrontend(BoundingPoly.Builder builderForValue)

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueBoundingPoly.Builder
Returns
TypeDescription
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
NameDescription
valuefloat

The confidence to set.

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

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

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

The id to set.

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

The bytes for id to set.

Returns
TypeDescription
Document.Entity.Builder

This builder for chaining.

setMentionId(String value)

public Document.Entity.Builder setMentionId(String value)

Deprecated. Use id field instead.

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)

Deprecated. Use id field instead.

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.

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
NameDescription
valueDocument.PageAnchor
Returns
TypeDescription
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
NameDescription
builderForValueDocument.PageAnchor.Builder
Returns
TypeDescription
Document.Entity.Builder

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.v1beta2.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.v1beta2.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)

Entity type from a schema e.g. Address.

string type = 2;

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)

Entity type from a schema e.g. Address.

string type = 2;

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