Class Document.Page.Layout.Builder (2.1.9)

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Page.Layout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Document.Page.Layout.Builder clear()
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides

clearBoundingPoly()

public Document.Page.Layout.Builder clearBoundingPoly()

The bounding polygon for the Layout.

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

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Page.Layout.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides

clearId()

public Document.Page.Layout.Builder clearId()

Optional. This is the identifier used by referencing PageAnchors.

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

Returns
TypeDescription
Document.Page.Layout.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Page.Layout.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides

clearOrientation()

public Document.Page.Layout.Builder clearOrientation()

Detected orientation for the Layout.

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

Returns
TypeDescription
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.v1beta2.Document.TextAnchor text_anchor = 1;

Returns
TypeDescription
Document.Page.Layout.Builder

clone()

public Document.Page.Layout.Builder clone()
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides

getBoundingPoly()

public BoundingPoly getBoundingPoly()

The bounding polygon for the Layout.

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

Returns
TypeDescription
BoundingPoly

The boundingPoly.

getBoundingPolyBuilder()

public BoundingPoly.Builder getBoundingPolyBuilder()

The bounding polygon for the Layout.

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

Returns
TypeDescription
BoundingPoly.Builder

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

getDescriptor()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

getTextAnchorBuilder()

public Document.TextAnchor.Builder getTextAnchorBuilder()

Text anchor indexing into the Document.text.

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

Returns
TypeDescription
Document.TextAnchor.Builder

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBoundingPoly(BoundingPoly value)

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

The bounding polygon for the Layout.

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

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Document.Page.Layout.Builder

mergeFrom(Document.Page.Layout other)

public Document.Page.Layout.Builder mergeFrom(Document.Page.Layout other)
Parameter
NameDescription
otherDocument.Page.Layout
Returns
TypeDescription
Document.Page.Layout.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Document.Page.Layout.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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.v1beta2.Document.TextAnchor text_anchor = 1;

Parameter
NameDescription
valueDocument.TextAnchor
Returns
TypeDescription
Document.Page.Layout.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.Layout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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.v1beta2.BoundingPoly bounding_poly = 3;

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
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.v1beta2.BoundingPoly bounding_poly = 3;

Parameter
NameDescription
builderForValueBoundingPoly.Builder
Returns
TypeDescription
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
NameDescription
valuefloat

The confidence to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides

setId(String value)

public Document.Page.Layout.Builder setId(String value)

Optional. This is the identifier used by referencing PageAnchors.

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

Parameter
NameDescription
valueString

The id to set.

Returns
TypeDescription
Document.Page.Layout.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Document.Page.Layout.Builder setIdBytes(ByteString value)

Optional. This is the identifier used by referencing PageAnchors.

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

Parameter
NameDescription
valueByteString

The bytes for id to set.

Returns
TypeDescription
Document.Page.Layout.Builder

This builder for chaining.

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.v1beta2.Document.Page.Layout.Orientation orientation = 4;

Parameter
NameDescription
valueDocument.Page.Layout.Orientation

The orientation to set.

Returns
TypeDescription
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.v1beta2.Document.Page.Layout.Orientation orientation = 4;

Parameter
NameDescription
valueint

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

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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.v1beta2.Document.TextAnchor text_anchor = 1;

Parameter
NameDescription
valueDocument.TextAnchor
Returns
TypeDescription
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.v1beta2.Document.TextAnchor text_anchor = 1;

Parameter
NameDescription
builderForValueDocument.TextAnchor.Builder
Returns
TypeDescription
Document.Page.Layout.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Page.Layout.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Page.Layout.Builder
Overrides