Package com.google.cloud.documentai.v1

Class Document.Page.Layout

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1.Document.Page.Layout

All Implemented Interfaces:

Document.Page.LayoutOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Document.Page

public static final class Document.Page.Layout
extends com.google.protobuf.GeneratedMessageV3
implements Document.Page.LayoutOrBuilder

 Visual element describing a layout unit on a page.
 

Protobuf type google.cloud.documentai.v1.Document.Page.Layout

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Document.Page.Layout.Builder	Visual element describing a layout unit on a page.
static class	Document.Page.Layout.Orientation	Detected human reading orientation.

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	Description
static int	BOUNDING_POLY_FIELD_NUMBER
static int	CONFIDENCE_FIELD_NUMBER
static int	ORIENTATION_FIELD_NUMBER
static int	TEXT_ANCHOR_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	Description
boolean	equals(Object obj)
BoundingPoly	getBoundingPoly()	The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
BoundingPolyOrBuilder	getBoundingPolyOrBuilder()	The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
float	getConfidence()	Confidence of the current [Layout][google.cloud.documentai.v1.Document.Page.Layout] within context of the object this layout is for.
static Document.Page.Layout	getDefaultInstance()
Document.Page.Layout	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document.Page.Layout.Orientation	getOrientation()	Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
int	getOrientationValue()	Detected orientation for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
com.google.protobuf.Parser<Document.Page.Layout>	getParserForType()
int	getSerializedSize()
Document.TextAnchor	getTextAnchor()	Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text].
Document.TextAnchorOrBuilder	getTextAnchorOrBuilder()	Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text].
boolean	hasBoundingPoly()	The bounding polygon for the [Layout][google.cloud.documentai.v1.Document.Page.Layout].
int	hashCode()
boolean	hasTextAnchor()	Text anchor indexing into the [Document.text][google.cloud.documentai.v1.Document.text].
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.Page.Layout.Builder	newBuilder()
static Document.Page.Layout.Builder	newBuilder(Document.Page.Layout prototype)
Document.Page.Layout.Builder	newBuilderForType()
protected Document.Page.Layout.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Document.Page.Layout	parseDelimitedFrom(InputStream input)
static Document.Page.Layout	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.Layout	parseFrom(byte[] data)
static Document.Page.Layout	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.Layout	parseFrom(com.google.protobuf.ByteString data)
static Document.Page.Layout	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.Layout	parseFrom(com.google.protobuf.CodedInputStream input)
static Document.Page.Layout	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.Layout	parseFrom(InputStream input)
static Document.Page.Layout	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.Layout	parseFrom(ByteBuffer data)
static Document.Page.Layout	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document.Page.Layout>	parser()
Document.Page.Layout.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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

TEXT_ANCHOR_FIELD_NUMBER

public static final int TEXT_ANCHOR_FIELD_NUMBER

See Also:

Constant Field Values

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER

See Also:

Constant Field Values

BOUNDING_POLY_FIELD_NUMBER

public static final int BOUNDING_POLY_FIELD_NUMBER

See Also:

Constant Field Values

ORIENTATION_FIELD_NUMBER

public static final int ORIENTATION_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

hasTextAnchor

public boolean hasTextAnchor()

 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
 

.google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;

Specified by:

hasTextAnchor in interface Document.Page.LayoutOrBuilder

Returns:

Whether the textAnchor field is set.

getTextAnchor

public Document.TextAnchor getTextAnchor()

 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
 

.google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;

Specified by:

getTextAnchor in interface Document.Page.LayoutOrBuilder

Returns:

The textAnchor.

getTextAnchorOrBuilder

public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
 

.google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1;

Specified by:

getTextAnchorOrBuilder in interface Document.Page.LayoutOrBuilder

getConfidence

public float getConfidence()

 Confidence of the current
 [Layout][google.cloud.documentai.v1.Document.Page.Layout] within
 context of the object this layout is for. e.g. confidence can be for a
 single token, a table, a visual element, etc. depending on context.
 Range `[0, 1]`.
 

float confidence = 2;

Specified by:

getConfidence in interface Document.Page.LayoutOrBuilder

Returns:

The confidence.

hasBoundingPoly

public boolean hasBoundingPoly()

 The bounding polygon for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
 

.google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;

Specified by:

hasBoundingPoly in interface Document.Page.LayoutOrBuilder

Returns:

Whether the boundingPoly field is set.

getBoundingPoly

public BoundingPoly getBoundingPoly()

 The bounding polygon for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
 

.google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;

Specified by:

getBoundingPoly in interface Document.Page.LayoutOrBuilder

Returns:

The boundingPoly.

getBoundingPolyOrBuilder

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

 The bounding polygon for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
 

.google.cloud.documentai.v1.BoundingPoly bounding_poly = 3;

Specified by:

getBoundingPolyOrBuilder in interface Document.Page.LayoutOrBuilder

getOrientationValue

public int getOrientationValue()

 Detected orientation for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
 

.google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4;

Specified by:

getOrientationValue in interface Document.Page.LayoutOrBuilder

Returns:

The enum numeric value on the wire for orientation.

getOrientation

public Document.Page.Layout.Orientation getOrientation()

 Detected orientation for the
 [Layout][google.cloud.documentai.v1.Document.Page.Layout].
 

.google.cloud.documentai.v1.Document.Page.Layout.Orientation orientation = 4;

Specified by:

getOrientation in interface Document.Page.LayoutOrBuilder

Returns:

The orientation.

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.Page.Layout parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Page.Layout parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Page.Layout 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.Page.Layout parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.Page.Layout parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Document.Page.Layout parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Document.Page.Layout parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Document.Page.Layout.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Document.Page.Layout.Builder newBuilder()

newBuilder

public static Document.Page.Layout.Builder newBuilder(Document.Page.Layout prototype)

toBuilder

public Document.Page.Layout.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Document.Page.Layout.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Document.Page.Layout getDefaultInstance()

parser

public static com.google.protobuf.Parser<Document.Page.Layout> parser()

getParserForType

public com.google.protobuf.Parser<Document.Page.Layout> 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.Page.Layout getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder