Class Document.PageAnchor

public static final class Document.PageAnchor extends GeneratedMessageV3 implements Document.PageAnchorOrBuilder

Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.

Protobuf type google.cloud.documentai.v1.Document.PageAnchor

Static Fields

PAGE_REFS_FIELD_NUMBER

public static final int PAGE_REFS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Document.PageAnchor prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getPageRefs(int index)

public Document.PageAnchor.PageRef getPageRefs(int index)

One or more references to visual page elements

repeated .google.cloud.documentai.v1.Document.PageAnchor.PageRef page_refs = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.PageAnchor.PageRef

getPageRefsCount()

public int getPageRefsCount()

One or more references to visual page elements

repeated .google.cloud.documentai.v1.Document.PageAnchor.PageRef page_refs = 1;

Returns
TypeDescription
int

getPageRefsList()

public List<Document.PageAnchor.PageRef> getPageRefsList()

One or more references to visual page elements

repeated .google.cloud.documentai.v1.Document.PageAnchor.PageRef page_refs = 1;

Returns
TypeDescription
List<PageRef>

getPageRefsOrBuilder(int index)

public Document.PageAnchor.PageRefOrBuilder getPageRefsOrBuilder(int index)

One or more references to visual page elements

repeated .google.cloud.documentai.v1.Document.PageAnchor.PageRef page_refs = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.PageAnchor.PageRefOrBuilder

getPageRefsOrBuilderList()

public List<? extends Document.PageAnchor.PageRefOrBuilder> getPageRefsOrBuilderList()

One or more references to visual page elements

repeated .google.cloud.documentai.v1.Document.PageAnchor.PageRef page_refs = 1;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1.Document.PageAnchor.PageRefOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.PageAnchor.Builder newBuilderForType()
Returns
TypeDescription
Document.PageAnchor.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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