Class Document.Entity (2.20.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
TypeDescription
int

MENTION_TEXT_FIELD_NUMBER

public static final int MENTION_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_ANCHOR_FIELD_NUMBER

public static final int TEXT_ANCHOR_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Entity getDefaultInstance()
Returns
TypeDescription
Document.Entity

getDescriptor()

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

newBuilder()

public static Document.Entity.Builder newBuilder()
Returns
TypeDescription
Document.Entity.Builder

newBuilder(Document.Entity prototype)

public static Document.Entity.Builder newBuilder(Document.Entity prototype)
Parameter
NameDescription
prototypeDocument.Entity
Returns
TypeDescription
Document.Entity.Builder

parseDelimitedFrom(InputStream input)

public static Document.Entity parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Entity parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Entity parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Entity parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.Entity parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Entity parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Document.Entity getDefaultInstanceForType()
Returns
TypeDescription
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
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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Document.Entity.Builder newBuilderForType()
Returns
TypeDescription
Document.Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Entity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Document.Entity.Builder toBuilder()
Returns
TypeDescription
Document.Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException