Class Document.PageAnchor.PageRef

public static final class Document.PageAnchor.PageRef extends GeneratedMessageV3 implements Document.PageAnchor.PageRefOrBuilder

Represents a weak reference to a page element within a document.

Protobuf type google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef

Static Fields

BOUNDING_POLY_FIELD_NUMBER

public static final int BOUNDING_POLY_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

LAYOUT_ID_FIELD_NUMBER

public static final int LAYOUT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

LAYOUT_TYPE_FIELD_NUMBER

public static final int LAYOUT_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_FIELD_NUMBER

public static final int PAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Document.PageAnchor.PageRef prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBoundingPoly()

public BoundingPoly getBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
BoundingPoly

The boundingPoly.

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

Optional. Identifies the bounding polygon of a layout element on the page.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

Optional. Confidence of detected page element, if applicable. Range [0, 1].

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

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

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

getLayoutId()

public String getLayoutId()

Optional. Deprecated. Use PageRef.bounding_poly instead.

string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The layoutId.

getLayoutIdBytes()

public ByteString getLayoutIdBytes()

Optional. Deprecated. Use PageRef.bounding_poly instead.

string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for layoutId.

getLayoutType()

public Document.PageAnchor.PageRef.LayoutType getLayoutType()

Optional. The type of the layout element that is being referenced if any.

.google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Document.PageAnchor.PageRef.LayoutType

The layoutType.

getLayoutTypeValue()

public int getLayoutTypeValue()

Optional. The type of the layout element that is being referenced if any.

.google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for layoutType.

getPage()

public long getPage()

Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.

int64 page = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
long

The page.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasBoundingPoly()

public boolean hasBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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