Class Document.Page.Layout.Builder (2.17.0)

Version 2.17.0

• 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.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

Inheritance

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

Implements

Document.Page.LayoutOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)