Class Document.Page.Layout (2.51.0)

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.v1.Document.Page.Layout

Static 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

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

Static Methods

getDefaultInstance()

public static Document.Page.Layout getDefaultInstance()
Returns
Type Description
Document.Page.Layout

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

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

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>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBoundingPoly()

public BoundingPoly getBoundingPoly()

The bounding polygon for the Layout.

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

Returns
Type Description
BoundingPoly

The boundingPoly.

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

The bounding polygon for the Layout.

.google.cloud.documentai.v1.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.

getDefaultInstanceForType()

public Document.Page.Layout getDefaultInstanceForType()
Returns
Type Description
Document.Page.Layout

getOrientation()

public Document.Page.Layout.Orientation getOrientation()

Detected orientation for the Layout.

.google.cloud.documentai.v1.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.v1.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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTextAnchor()

public Document.TextAnchor getTextAnchor()

Text anchor indexing into the Document.text.

.google.cloud.documentai.v1.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.v1.Document.TextAnchor text_anchor = 1;

Returns
Type Description
Document.TextAnchorOrBuilder

hasBoundingPoly()

public boolean hasBoundingPoly()

The bounding polygon for the Layout.

.google.cloud.documentai.v1.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.v1.Document.TextAnchor text_anchor = 1;

Returns
Type Description
boolean

Whether the textAnchor field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException