Class Document.Page.Layout

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

Static Fields

BOUNDING_POLY_FIELD_NUMBER

public static final int BOUNDING_POLY_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

ORIENTATION_FIELD_NUMBER

public static final int ORIENTATION_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_ANCHOR_FIELD_NUMBER

public static final int TEXT_ANCHOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Page.Layout getDefaultInstance()
Returns
TypeDescription
Document.Page.Layout

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

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

newBuilder(Document.Page.Layout prototype)

public static Document.Page.Layout.Builder newBuilder(Document.Page.Layout prototype)
Parameter
NameDescription
prototypeDocument.Page.Layout
Returns
TypeDescription
Document.Page.Layout.Builder

parseDelimitedFrom(InputStream input)

public static Document.Page.Layout parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Page.Layout parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Page.Layout parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Page.Layout parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.Page.Layout parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Page.Layout parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Page.Layout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Page.Layout
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBoundingPoly()

public BoundingPoly getBoundingPoly()

The bounding polygon for the Layout.

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

Returns
TypeDescription
BoundingPoly

The boundingPoly.

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

The bounding polygon for the Layout.

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

Returns
TypeDescription
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
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Document.Page.Layout getDefaultInstanceForType()
Returns
TypeDescription
Document.Page.Layout

getId()

public String getId()

Optional. This is the identifier used by referencing PageAnchors.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for orientation.

getParserForType()

public Parser<Document.Page.Layout> getParserForType()
Returns
TypeDescription
Parser<Layout>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTextAnchor()

public Document.TextAnchor getTextAnchor()

Text anchor indexing into the Document.text.

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

Returns
TypeDescription
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
TypeDescription
Document.TextAnchorOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasBoundingPoly()

public boolean hasBoundingPoly()

The bounding polygon for the Layout.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the textAnchor field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Document.Page.Layout.Builder newBuilderForType()
Returns
TypeDescription
Document.Page.Layout.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Page.Layout.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Document.Page.Layout.Builder toBuilder()
Returns
TypeDescription
Document.Page.Layout.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException