Interface Document.PageAnchor.PageRefOrBuilder (2.41.0)

public static interface Document.PageAnchor.PageRefOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoundingPoly()

public abstract 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 abstract 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 abstract 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.

getLayoutId() (deprecated)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

hasBoundingPoly()

public abstract 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.