Class Document.Page.Layout.Builder (2.50.0)

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

Visual element describing a layout unit on a page.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.Layout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Page.Layout.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Document.Page.Layout.Builder clear()
Returns
Type Description
Document.Page.Layout.Builder
Overrides

clearBoundingPoly()

public Document.Page.Layout.Builder clearBoundingPoly()

The bounding polygon for the Layout.

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

Returns
Type Description
Document.Page.Layout.Builder

clearConfidence()

public Document.Page.Layout.Builder clearConfidence()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Page.Layout.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Document.Page.Layout.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Page.Layout.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Document.Page.Layout.Builder
Overrides

clearOrientation()

public Document.Page.Layout.Builder clearOrientation()

Detected orientation for the Layout.

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

Returns
Type Description
Document.Page.Layout.Builder

This builder for chaining.

clearTextAnchor()

public Document.Page.Layout.Builder clearTextAnchor()

Text anchor indexing into the Document.text.

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

Returns
Type Description
Document.Page.Layout.Builder

clone()

public Document.Page.Layout.Builder clone()
Returns
Type Description
Document.Page.Layout.Builder
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.

getBoundingPolyBuilder()

public BoundingPoly.Builder getBoundingPolyBuilder()

The bounding polygon for the Layout.

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

Returns
Type Description
BoundingPoly.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getTextAnchorBuilder()

public Document.TextAnchor.Builder getTextAnchorBuilder()

Text anchor indexing into the Document.text.

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

Returns
Type Description
Document.TextAnchor.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoundingPoly(BoundingPoly value)

public Document.Page.Layout.Builder mergeBoundingPoly(BoundingPoly value)

The bounding polygon for the Layout.

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

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Document.Page.Layout.Builder

mergeFrom(Document.Page.Layout other)

public Document.Page.Layout.Builder mergeFrom(Document.Page.Layout other)
Parameter
Name Description
other Document.Page.Layout
Returns
Type Description
Document.Page.Layout.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Page.Layout.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Page.Layout.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Document.Page.Layout.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.Page.Layout.Builder
Overrides

mergeTextAnchor(Document.TextAnchor value)

public Document.Page.Layout.Builder mergeTextAnchor(Document.TextAnchor value)

Text anchor indexing into the Document.text.

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

Parameter
Name Description
value Document.TextAnchor
Returns
Type Description
Document.Page.Layout.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.Layout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Page.Layout.Builder
Overrides

setBoundingPoly(BoundingPoly value)

public Document.Page.Layout.Builder setBoundingPoly(BoundingPoly value)

The bounding polygon for the Layout.

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

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Document.Page.Layout.Builder

setBoundingPoly(BoundingPoly.Builder builderForValue)

public Document.Page.Layout.Builder setBoundingPoly(BoundingPoly.Builder builderForValue)

The bounding polygon for the Layout.

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

Parameter
Name Description
builderForValue BoundingPoly.Builder
Returns
Type Description
Document.Page.Layout.Builder

setConfidence(float value)

public Document.Page.Layout.Builder setConfidence(float value)

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;

Parameter
Name Description
value float

The confidence to set.

Returns
Type Description
Document.Page.Layout.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.Layout.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Page.Layout.Builder
Overrides

setOrientation(Document.Page.Layout.Orientation value)

public Document.Page.Layout.Builder setOrientation(Document.Page.Layout.Orientation value)

Detected orientation for the Layout.

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

Parameter
Name Description
value Document.Page.Layout.Orientation

The orientation to set.

Returns
Type Description
Document.Page.Layout.Builder

This builder for chaining.

setOrientationValue(int value)

public Document.Page.Layout.Builder setOrientationValue(int value)

Detected orientation for the Layout.

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

Parameter
Name Description
value int

The enum numeric value on the wire for orientation to set.

Returns
Type Description
Document.Page.Layout.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Page.Layout.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Document.Page.Layout.Builder
Overrides

setTextAnchor(Document.TextAnchor value)

public Document.Page.Layout.Builder setTextAnchor(Document.TextAnchor value)

Text anchor indexing into the Document.text.

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

Parameter
Name Description
value Document.TextAnchor
Returns
Type Description
Document.Page.Layout.Builder

setTextAnchor(Document.TextAnchor.Builder builderForValue)

public Document.Page.Layout.Builder setTextAnchor(Document.TextAnchor.Builder builderForValue)

Text anchor indexing into the Document.text.

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

Parameter
Name Description
builderForValue Document.TextAnchor.Builder
Returns
Type Description
Document.Page.Layout.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.Layout.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Page.Layout.Builder
Overrides