com.google.cloud.documentai.v1beta3

Interface Document.PageAnchor.PageRefOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Document.PageAnchor.PageRef, Document.PageAnchor.PageRef.Builder

Enclosing class:

Document.PageAnchor

public static interface Document.PageAnchor.PageRefOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
BoundingPoly	getBoundingPoly() Optional.
BoundingPolyOrBuilder	getBoundingPolyOrBuilder() Optional.
String	getLayoutId() Deprecated.
com.google.protobuf.ByteString	getLayoutIdBytes() Deprecated.
Document.PageAnchor.PageRef.LayoutType	getLayoutType() Optional.
int	getLayoutTypeValue() Optional.
long	getPage() Required.
boolean	hasBoundingPoly() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPage

long getPage()

 Required. Index into the [Document.pages][google.cloud.documentai.v1beta3.Document.pages] element
 

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

Returns:

The page.

getLayoutTypeValue

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:

The enum numeric value on the wire for layoutType.

getLayoutType

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:

The layoutType.

getLayoutId

@Deprecated
String getLayoutId()

Deprecated.

 Optional. Deprecated.  Use [PageRef.bounding_poly][google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.bounding_poly] instead.
 

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

Returns:

The layoutId.

getLayoutIdBytes

@Deprecated
com.google.protobuf.ByteString getLayoutIdBytes()

Deprecated.

 Optional. Deprecated.  Use [PageRef.bounding_poly][google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.bounding_poly] instead.
 

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

Returns:

The bytes for layoutId.

hasBoundingPoly

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:

Whether the boundingPoly field is set.

getBoundingPoly

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:

The boundingPoly.

getBoundingPolyOrBuilder

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