com.google.cloud.documentai.v1beta2

Class Document.Entity

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta2.Document.Entity

All Implemented Interfaces:

Document.EntityOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Document

public static final class Document.Entity
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.Entity.Builder A phrase in the text that is a known entity type, such as a person, an organization, or location.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOUNDING_POLY_FOR_DEMO_FRONTEND_FIELD_NUMBER
static int	CONFIDENCE_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	MENTION_ID_FIELD_NUMBER
static int	MENTION_TEXT_FIELD_NUMBER
static int	PAGE_ANCHOR_FIELD_NUMBER
static int	TEXT_ANCHOR_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BoundingPoly	getBoundingPolyForDemoFrontend() Optional.
BoundingPolyOrBuilder	getBoundingPolyForDemoFrontendOrBuilder() Optional.
float	getConfidence() Optional.
static Document.Entity	getDefaultInstance()
Document.Entity	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getId() Optional.
com.google.protobuf.ByteString	getIdBytes() Optional.
String	getMentionId() Deprecated.
com.google.protobuf.ByteString	getMentionIdBytes() Deprecated.
String	getMentionText() Text value in the document e.g.
com.google.protobuf.ByteString	getMentionTextBytes() Text value in the document e.g.
Document.PageAnchor	getPageAnchor() Optional.
Document.PageAnchorOrBuilder	getPageAnchorOrBuilder() Optional.
com.google.protobuf.Parser<Document.Entity>	getParserForType()
int	getSerializedSize()
Document.TextAnchor	getTextAnchor() Provenance of the entity.
Document.TextAnchorOrBuilder	getTextAnchorOrBuilder() Provenance of the entity.
String	getType() Entity type from a schema e.g.
com.google.protobuf.ByteString	getTypeBytes() Entity type from a schema e.g.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBoundingPolyForDemoFrontend() Optional.
int	hashCode()
boolean	hasPageAnchor() Optional.
boolean	hasTextAnchor() Provenance of the entity.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.Entity.Builder	newBuilder()
static Document.Entity.Builder	newBuilder(Document.Entity prototype)
Document.Entity.Builder	newBuilderForType()
protected Document.Entity.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Document.Entity	parseDelimitedFrom(InputStream input)
static Document.Entity	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Entity	parseFrom(byte[] data)
static Document.Entity	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Entity	parseFrom(ByteBuffer data)
static Document.Entity	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Entity	parseFrom(com.google.protobuf.ByteString data)
static Document.Entity	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Entity	parseFrom(com.google.protobuf.CodedInputStream input)
static Document.Entity	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Entity	parseFrom(InputStream input)
static Document.Entity	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document.Entity>	parser()
Document.Entity.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TEXT_ANCHOR_FIELD_NUMBER

public static final int TEXT_ANCHOR_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

MENTION_TEXT_FIELD_NUMBER

public static final int MENTION_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

MENTION_ID_FIELD_NUMBER

public static final int MENTION_ID_FIELD_NUMBER

See Also:

Constant Field Values

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_ANCHOR_FIELD_NUMBER

public static final int PAGE_ANCHOR_FIELD_NUMBER

See Also:

Constant Field Values

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

BOUNDING_POLY_FOR_DEMO_FRONTEND_FIELD_NUMBER

public static final int BOUNDING_POLY_FOR_DEMO_FRONTEND_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasTextAnchor

public boolean hasTextAnchor()

 Provenance of the entity.
 Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

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

Specified by:

hasTextAnchor in interface Document.EntityOrBuilder

Returns:

Whether the textAnchor field is set.

getTextAnchor

public Document.TextAnchor getTextAnchor()

 Provenance of the entity.
 Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

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

Specified by:

getTextAnchor in interface Document.EntityOrBuilder

Returns:

The textAnchor.

getTextAnchorOrBuilder

public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

 Provenance of the entity.
 Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

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

Specified by:

getTextAnchorOrBuilder in interface Document.EntityOrBuilder

getType

public String getType()

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

string type = 2;

Specified by:

getType in interface Document.EntityOrBuilder

Returns:

The type.

getTypeBytes

public com.google.protobuf.ByteString getTypeBytes()

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

string type = 2;

Specified by:

getTypeBytes in interface Document.EntityOrBuilder

Returns:

The bytes for type.

getMentionText

public String getMentionText()

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

string mention_text = 3;

Specified by:

getMentionText in interface Document.EntityOrBuilder

Returns:

The mentionText.

getMentionTextBytes

public com.google.protobuf.ByteString getMentionTextBytes()

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

string mention_text = 3;

Specified by:

getMentionTextBytes in interface Document.EntityOrBuilder

Returns:

The bytes for mentionText.

getMentionId

public String getMentionId()

 Deprecated.  Use `id` field instead.
 

string mention_id = 4;

Specified by:

getMentionId in interface Document.EntityOrBuilder

Returns:

The mentionId.

getMentionIdBytes

public com.google.protobuf.ByteString getMentionIdBytes()

 Deprecated.  Use `id` field instead.
 

string mention_id = 4;

Specified by:

getMentionIdBytes in interface Document.EntityOrBuilder

Returns:

The bytes for mentionId.

getConfidence

public float getConfidence()

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

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

Specified by:

getConfidence in interface Document.EntityOrBuilder

Returns:

The confidence.

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];

Specified by:

hasPageAnchor in interface Document.EntityOrBuilder

Returns:

Whether the pageAnchor field is set.

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];

Specified by:

getPageAnchor in interface Document.EntityOrBuilder

Returns:

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];

Specified by:

getPageAnchorOrBuilder in interface Document.EntityOrBuilder

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];

Specified by:

getId in interface Document.EntityOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.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];

Specified by:

getIdBytes in interface Document.EntityOrBuilder

Returns:

The bytes for id.

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];

Specified by:

hasBoundingPolyForDemoFrontend in interface Document.EntityOrBuilder

Returns:

Whether the boundingPolyForDemoFrontend field is set.

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];

Specified by:

getBoundingPolyForDemoFrontend in interface Document.EntityOrBuilder

Returns:

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];

Specified by:

getBoundingPolyForDemoFrontendOrBuilder in interface Document.EntityOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Document.Entity parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Entity parseFrom(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Entity parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Entity parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Entity parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Entity parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Entity parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static Document.Entity parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.Entity parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.Entity parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static Document.Entity parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static Document.Entity parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public Document.Entity.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Document.Entity.Builder newBuilder()

newBuilder

public static Document.Entity.Builder newBuilder(Document.Entity prototype)

toBuilder

public Document.Entity.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Document.Entity.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Document.Entity getDefaultInstance()

parser

public static com.google.protobuf.Parser<Document.Entity> parser()

getParserForType

public com.google.protobuf.Parser<Document.Entity> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Document.Entity getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder