Class Document.PageAnchor.PageRef (2.52.0)

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.v1.Document.PageAnchor.PageRef

Static Fields

BOUNDING_POLY_FIELD_NUMBER

public static final int BOUNDING_POLY_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

LAYOUT_ID_FIELD_NUMBER

public static final int LAYOUT_ID_FIELD_NUMBER
Field Value
Type Description
int

LAYOUT_TYPE_FIELD_NUMBER

public static final int LAYOUT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_FIELD_NUMBER

public static final int PAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.PageAnchor.PageRef getDefaultInstance()
Returns
Type Description
Document.PageAnchor.PageRef

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Document.PageAnchor.PageRef.Builder newBuilder()
Returns
Type Description
Document.PageAnchor.PageRef.Builder

newBuilder(Document.PageAnchor.PageRef prototype)

public static Document.PageAnchor.PageRef.Builder newBuilder(Document.PageAnchor.PageRef prototype)
Parameter
Name Description
prototype Document.PageAnchor.PageRef
Returns
Type Description
Document.PageAnchor.PageRef.Builder

parseDelimitedFrom(InputStream input)

public static Document.PageAnchor.PageRef parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.PageAnchor.PageRef parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.PageAnchor.PageRef parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.PageAnchor.PageRef parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.PageAnchor.PageRef parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.PageAnchor.PageRef parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.PageAnchor.PageRef parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.PageAnchor.PageRef parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.PageAnchor.PageRef parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.PageAnchor.PageRef parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.PageAnchor.PageRef parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.PageAnchor.PageRef parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.PageAnchor.PageRef
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBoundingPoly()

public BoundingPoly getBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

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

Returns
Type Description
BoundingPoly

The boundingPoly.

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

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

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

The confidence.

getDefaultInstanceForType()

public Document.PageAnchor.PageRef getDefaultInstanceForType()
Returns
Type Description
Document.PageAnchor.PageRef

getLayoutId() (deprecated)

public String getLayoutId()

Deprecated. google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752

Optional. Deprecated. Use PageRef.bounding_poly instead.

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

Returns
Type Description
String

The layoutId.

getLayoutIdBytes() (deprecated)

public ByteString getLayoutIdBytes()

Deprecated. google.cloud.documentai.v1.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1/document.proto;l=752

Optional. Deprecated. Use PageRef.bounding_poly instead.

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

Returns
Type Description
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.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
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.v1.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

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

The page.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasBoundingPoly()

public boolean hasBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

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

Returns
Type Description
boolean

Whether the boundingPoly field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.PageAnchor.PageRef.Builder newBuilderForType()
Returns
Type Description
Document.PageAnchor.PageRef.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.PageAnchor.PageRef.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.PageAnchor.PageRef.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Document.PageAnchor.PageRef.Builder toBuilder()
Returns
Type Description
Document.PageAnchor.PageRef.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException