com.google.cloud.documentai.v1beta2

Class Document.PageAnchor.PageRef

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef

All Implemented Interfaces:

Document.PageAnchor.PageRefOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Document.PageAnchor

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.PageAnchor.PageRef.Builder Represents a weak reference to a page element within a document.
static class	Document.PageAnchor.PageRef.LayoutType The type of layout that is being referenced.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOUNDING_POLY_FIELD_NUMBER
static int	CONFIDENCE_FIELD_NUMBER
static int	LAYOUT_ID_FIELD_NUMBER
static int	LAYOUT_TYPE_FIELD_NUMBER
static int	PAGE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BoundingPoly	getBoundingPoly() Optional.
BoundingPolyOrBuilder	getBoundingPolyOrBuilder() Optional.
float	getConfidence() Optional.
static Document.PageAnchor.PageRef	getDefaultInstance()
Document.PageAnchor.PageRef	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getLayoutId() Deprecated. google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1beta2/document.proto;l=782
com.google.protobuf.ByteString	getLayoutIdBytes() Deprecated. google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1beta2/document.proto;l=782
Document.PageAnchor.PageRef.LayoutType	getLayoutType() Optional.
int	getLayoutTypeValue() Optional.
long	getPage() Required.
com.google.protobuf.Parser<Document.PageAnchor.PageRef>	getParserForType()
int	getSerializedSize()
boolean	hasBoundingPoly() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.PageAnchor.PageRef.Builder	newBuilder()
static Document.PageAnchor.PageRef.Builder	newBuilder(Document.PageAnchor.PageRef prototype)
Document.PageAnchor.PageRef.Builder	newBuilderForType()
protected Document.PageAnchor.PageRef.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Document.PageAnchor.PageRef	parseDelimitedFrom(InputStream input)
static Document.PageAnchor.PageRef	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.PageAnchor.PageRef	parseFrom(byte[] data)
static Document.PageAnchor.PageRef	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.PageAnchor.PageRef	parseFrom(ByteBuffer data)
static Document.PageAnchor.PageRef	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.PageAnchor.PageRef	parseFrom(com.google.protobuf.ByteString data)
static Document.PageAnchor.PageRef	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.PageAnchor.PageRef	parseFrom(com.google.protobuf.CodedInputStream input)
static Document.PageAnchor.PageRef	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.PageAnchor.PageRef	parseFrom(InputStream input)
static Document.PageAnchor.PageRef	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document.PageAnchor.PageRef>	parser()
Document.PageAnchor.PageRef.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PAGE_FIELD_NUMBER

public static final int PAGE_FIELD_NUMBER

See Also:

Constant Field Values

LAYOUT_TYPE_FIELD_NUMBER

public static final int LAYOUT_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

LAYOUT_ID_FIELD_NUMBER

public static final int LAYOUT_ID_FIELD_NUMBER

See Also:

Constant Field Values

BOUNDING_POLY_FIELD_NUMBER

public static final int BOUNDING_POLY_FIELD_NUMBER

See Also:

Constant Field Values

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPage

public long getPage()

 Required. Index into the
 [Document.pages][google.cloud.documentai.v1beta2.Document.pages]
 element, for example using
 `[Document.pages][page_refs.page]` 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];

Specified by:

getPage in interface Document.PageAnchor.PageRefOrBuilder

Returns:

The page.

getLayoutTypeValue

public int getLayoutTypeValue()

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

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

Specified by:

getLayoutTypeValue in interface Document.PageAnchor.PageRefOrBuilder

Returns:

The enum numeric value on the wire for layoutType.

getLayoutType

public Document.PageAnchor.PageRef.LayoutType getLayoutType()

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

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

Specified by:

getLayoutType in interface Document.PageAnchor.PageRefOrBuilder

Returns:

The layoutType.

getLayoutId

@Deprecated
public String getLayoutId()

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

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

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

Specified by:

getLayoutId in interface Document.PageAnchor.PageRefOrBuilder

Returns:

The layoutId.

getLayoutIdBytes

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

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

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

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

Specified by:

getLayoutIdBytes in interface Document.PageAnchor.PageRefOrBuilder

Returns:

The bytes for layoutId.

hasBoundingPoly

public boolean hasBoundingPoly()

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

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

Specified by:

hasBoundingPoly in interface Document.PageAnchor.PageRefOrBuilder

Returns:

Whether the boundingPoly field is set.

getBoundingPoly

public BoundingPoly getBoundingPoly()

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

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

Specified by:

getBoundingPoly in interface Document.PageAnchor.PageRefOrBuilder

Returns:

The boundingPoly.

getBoundingPolyOrBuilder

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

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

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

Specified by:

getBoundingPolyOrBuilder in interface Document.PageAnchor.PageRefOrBuilder

getConfidence

public float getConfidence()

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

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

Specified by:

getConfidence in interface Document.PageAnchor.PageRefOrBuilder

Returns:

The confidence.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Document.PageAnchor.PageRef parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.PageAnchor.PageRef parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.PageAnchor.PageRef parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static Document.PageAnchor.PageRef parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public Document.PageAnchor.PageRef.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

newBuilder

public static Document.PageAnchor.PageRef.Builder newBuilder(Document.PageAnchor.PageRef prototype)

toBuilder

public Document.PageAnchor.PageRef.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Document.PageAnchor.PageRef.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Document.PageAnchor.PageRef getDefaultInstance()

parser

public static com.google.protobuf.Parser<Document.PageAnchor.PageRef> parser()

getParserForType

public com.google.protobuf.Parser<Document.PageAnchor.PageRef> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Document.PageAnchor.PageRef getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder