Class Document.Entity (2.47.0)

public static final class Document.Entity extends GeneratedMessageV3 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 Fields

MENTION_ID_FIELD_NUMBER

public static final int MENTION_ID_FIELD_NUMBER
Field Value
Type Description
int

MENTION_TEXT_FIELD_NUMBER

public static final int MENTION_TEXT_FIELD_NUMBER
Field Value
Type Description
int

TEXT_ANCHOR_FIELD_NUMBER

public static final int TEXT_ANCHOR_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.Entity getDefaultInstance()
Returns
Type Description
Document.Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Document.Entity.Builder newBuilder()
Returns
Type Description
Document.Entity.Builder

newBuilder(Document.Entity prototype)

public static Document.Entity.Builder newBuilder(Document.Entity prototype)
Parameter
Name Description
prototype Document.Entity
Returns
Type Description
Document.Entity.Builder

parseDelimitedFrom(InputStream input)

public static Document.Entity parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Entity
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Entity
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.Entity parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Entity parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Entity parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.Entity
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.Entity parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Entity
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.Entity parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Entity> parser()
Returns
Type Description
Parser<Entity>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Document.Entity getDefaultInstanceForType()
Returns
Type Description
Document.Entity

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
Type Description
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
Type Description
ByteString

The bytes for mentionId.

getMentionText()

public String getMentionText()

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

string mention_text = 3;

Returns
Type Description
String

The mentionText.

getMentionTextBytes()

public ByteString getMentionTextBytes()

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

string mention_text = 3;

Returns
Type Description
ByteString

The bytes for mentionText.

getParserForType()

public Parser<Document.Entity> getParserForType()
Returns
Type Description
Parser<Entity>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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
Type Description
Document.TextAnchor

The textAnchor.

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

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
Type Description
boolean

Whether the textAnchor field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.Entity.Builder newBuilderForType()
Returns
Type Description
Document.Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.Entity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Document.Entity.Builder toBuilder()
Returns
Type Description
Document.Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException