Class Document.Page.Layout (2.1.9)

Version 2.1.9

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

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

Visual element describing a layout unit on a page.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.Page.Layout

Implements

Document.Page.LayoutOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value

Type	Description
int

ORIENTATION_FIELD_NUMBER

public static final int ORIENTATION_FIELD_NUMBER

Field Value

Type	Description
int

TEXT_ANCHOR_FIELD_NUMBER

public static final int TEXT_ANCHOR_FIELD_NUMBER

Field Value

Type	Description
int

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBoundingPoly()

public BoundingPoly getBoundingPoly()

The bounding polygon for the Layout.

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

Returns

Type	Description
BoundingPoly	The boundingPoly.

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

The bounding polygon for the Layout.

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

Returns

Type	Description
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

Confidence of the current 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;

Returns

Type	Description
float	The confidence.

getDefaultInstance()

public static Document.Page.Layout getDefaultInstance()

Returns

Type	Description
Document.Page.Layout

getDefaultInstanceForType()

public Document.Page.Layout getDefaultInstanceForType()

Returns

Type	Description
Document.Page.Layout

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getId()

public String getId()

Optional. This is the identifier used by referencing PageAnchors.

string id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The id.

getIdBytes()

public ByteString getIdBytes()

Optional. This is the identifier used by referencing PageAnchors.

string id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for id.

getOrientation()

public Document.Page.Layout.Orientation getOrientation()

Detected orientation for the Layout.

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

Returns

Type	Description
Document.Page.Layout.Orientation	The orientation.

getOrientationValue()

public int getOrientationValue()

Detected orientation for the Layout.

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

Returns

Type	Description
int	The enum numeric value on the wire for orientation.

getParserForType()

public Parser<Document.Page.Layout> getParserForType()

Returns

Type	Description
Parser<Layout>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTextAnchor()

public Document.TextAnchor getTextAnchor()

Text anchor indexing into the Document.text.

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

Returns

Type	Description
Document.TextAnchor	The textAnchor.

getTextAnchorOrBuilder()

public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

Text anchor indexing into the Document.text.

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

Returns

Type	Description
Document.TextAnchorOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasBoundingPoly()

public boolean hasBoundingPoly()

The bounding polygon for the Layout.

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

Returns

Type	Description
boolean	Whether the boundingPoly field is set.

hasTextAnchor()

public boolean hasTextAnchor()

Text anchor indexing into the Document.text.

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

Returns

Type	Description
boolean	Whether the textAnchor field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilder()

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

Returns

Type	Description
Document.Page.Layout.Builder

newBuilder(Document.Page.Layout prototype)

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

Parameter

Name	Description
prototype	Document.Page.Layout

Returns

Type	Description
Document.Page.Layout.Builder

newBuilderForType()

public Document.Page.Layout.Builder newBuilderForType()

Returns

Type	Description
Document.Page.Layout.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Document.Page.Layout.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

parseDelimitedFrom(InputStream input)

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

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Document.Page.Layout parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page.Layout parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page.Layout parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

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

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Document.Page.Layout parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Document.Page.Layout

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

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

Returns

Type	Description
Parser<Layout>

toBuilder()

public Document.Page.Layout.Builder toBuilder()

Returns

Type	Description
Document.Page.Layout.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException