Class Document.Entity (2.1.9)

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

Inheritance

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

Implements

Document.EntityOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Fields

BOUNDING_POLY_FOR_DEMO_FRONTEND_FIELD_NUMBER

public static final int BOUNDING_POLY_FOR_DEMO_FRONTEND_FIELD_NUMBER

Field Value

Type	Description
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER

Field Value

Type	Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value

Type	Description
int

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

PAGE_ANCHOR_FIELD_NUMBER

public static final int PAGE_ANCHOR_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

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	`Object`

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

Type	Description
BoundingPoly	The boundingPolyForDemoFrontend.

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

Type	Description
BoundingPolyOrBuilder

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.

getDefaultInstance()

public static Document.Entity getDefaultInstance()

Returns

Type	Description
Document.Entity

getDefaultInstanceForType()

public Document.Entity getDefaultInstanceForType()

Returns

Type	Description
Document.Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

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()

Deprecated. Use id field instead.

string mention_id = 4;

Returns

Type	Description
String	The mentionId.

getMentionIdBytes()

public ByteString getMentionIdBytes()

Deprecated. Use id field instead.

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.

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.

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

getParserForType()

public Parser<Document.Entity> getParserForType()

Returns

Type	Description
Parser<Entity>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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

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

Returns

Type	Description
Document.TextAnchorOrBuilder

getType()

public String getType()

Entity type from a schema e.g. Address.

string type = 2;

Returns

Type	Description
String	The type.

getTypeBytes()

public ByteString getTypeBytes()

Entity type from a schema e.g. Address.

string type = 2;

Returns

Type	Description
ByteString	The bytes for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

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

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

Type	Description
boolean	Whether the textAnchor field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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>

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException