Class Document.DocumentLayout.DocumentLayoutBlock.Builder (2.66.0)

public static final class Document.DocumentLayout.DocumentLayoutBlock.Builder extends GeneratedMessageV3.Builder<Document.DocumentLayout.DocumentLayoutBlock.Builder> implements Document.DocumentLayout.DocumentLayoutBlockOrBuilder

Represents a block. A block could be one of the various types (text, table, list) supported.

Protobuf type google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Document.DocumentLayout.DocumentLayoutBlock build()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock

buildPartial()

public Document.DocumentLayout.DocumentLayoutBlock buildPartial()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock

clear()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clear()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder
Overrides

clearBlock()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clearBlock()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

clearBlockId()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clearBlockId()

ID of the block.

string block_id = 1;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

This builder for chaining.

clearBoundingBox()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clearBoundingBox()

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearListBlock()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clearListBlock()

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSpan()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clearPageSpan()

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

clearTableBlock()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clearTableBlock()

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

clearTextBlock()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clearTextBlock()

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

clone()

public Document.DocumentLayout.DocumentLayoutBlock.Builder clone()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder
Overrides

getBlockCase()

public Document.DocumentLayout.DocumentLayoutBlock.BlockCase getBlockCase()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.BlockCase

getBlockId()

public String getBlockId()

ID of the block.

string block_id = 1;

Returns
Type Description
String

The blockId.

getBlockIdBytes()

public ByteString getBlockIdBytes()

ID of the block.

string block_id = 1;

Returns
Type Description
ByteString

The bytes for blockId.

getBoundingBox()

public BoundingPoly getBoundingBox()

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Returns
Type Description
BoundingPoly

The boundingBox.

getBoundingBoxBuilder()

public BoundingPoly.Builder getBoundingBoxBuilder()

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Returns
Type Description
BoundingPoly.Builder

getBoundingBoxOrBuilder()

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Returns
Type Description
BoundingPolyOrBuilder

getDefaultInstanceForType()

public Document.DocumentLayout.DocumentLayoutBlock getDefaultInstanceForType()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock

getDescriptorForType()

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

getListBlock()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock getListBlock()

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock

The listBlock.

getListBlockBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock.Builder getListBlockBuilder()

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock.Builder

getListBlockOrBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlockOrBuilder getListBlockOrBuilder()

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlockOrBuilder

getPageSpan()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan getPageSpan()

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan

The pageSpan.

getPageSpanBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan.Builder getPageSpanBuilder()

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan.Builder

getPageSpanOrBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpanOrBuilder getPageSpanOrBuilder()

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpanOrBuilder

getTableBlock()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock getTableBlock()

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock

The tableBlock.

getTableBlockBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock.Builder getTableBlockBuilder()

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock.Builder

getTableBlockOrBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlockOrBuilder getTableBlockOrBuilder()

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlockOrBuilder

getTextBlock()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock getTextBlock()

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock

The textBlock.

getTextBlockBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock.Builder getTextBlockBuilder()

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock.Builder

getTextBlockOrBuilder()

public Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlockOrBuilder getTextBlockOrBuilder()

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlockOrBuilder

hasBoundingBox()

public boolean hasBoundingBox()

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Returns
Type Description
boolean

Whether the boundingBox field is set.

hasListBlock()

public boolean hasListBlock()

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Returns
Type Description
boolean

Whether the listBlock field is set.

hasPageSpan()

public boolean hasPageSpan()

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Returns
Type Description
boolean

Whether the pageSpan field is set.

hasTableBlock()

public boolean hasTableBlock()

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Returns
Type Description
boolean

Whether the tableBlock field is set.

hasTextBlock()

public boolean hasTextBlock()

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Returns
Type Description
boolean

Whether the textBlock field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoundingBox(BoundingPoly value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder mergeBoundingBox(BoundingPoly value)

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

mergeFrom(Document.DocumentLayout.DocumentLayoutBlock other)

public Document.DocumentLayout.DocumentLayoutBlock.Builder mergeFrom(Document.DocumentLayout.DocumentLayoutBlock other)
Parameter
Name Description
other Document.DocumentLayout.DocumentLayoutBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Document.DocumentLayout.DocumentLayoutBlock.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder
Overrides

mergeListBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder mergeListBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock value)

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

mergePageSpan(Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder mergePageSpan(Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan value)

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

mergeTableBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder mergeTableBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock value)

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

mergeTextBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder mergeTextBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock value)

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBlockId(String value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setBlockId(String value)

ID of the block.

string block_id = 1;

Parameter
Name Description
value String

The blockId to set.

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

This builder for chaining.

setBlockIdBytes(ByteString value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setBlockIdBytes(ByteString value)

ID of the block.

string block_id = 1;

Parameter
Name Description
value ByteString

The bytes for blockId to set.

Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

This builder for chaining.

setBoundingBox(BoundingPoly value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setBoundingBox(BoundingPoly value)

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setBoundingBox(BoundingPoly.Builder builderForValue)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setBoundingBox(BoundingPoly.Builder builderForValue)

Identifies the bounding box for the block.

.google.cloud.documentai.v1.BoundingPoly bounding_box = 6;

Parameter
Name Description
builderForValue BoundingPoly.Builder
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setListBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setListBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock value)

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setListBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock.Builder builderForValue)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setListBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock.Builder builderForValue)

Block consisting of list content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock list_block = 4;

Parameter
Name Description
builderForValue Document.DocumentLayout.DocumentLayoutBlock.LayoutListBlock.Builder
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setPageSpan(Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setPageSpan(Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan value)

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setPageSpan(Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan.Builder builderForValue)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setPageSpan(Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan.Builder builderForValue)

Page span of the block.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan page_span = 5;

Parameter
Name Description
builderForValue Document.DocumentLayout.DocumentLayoutBlock.LayoutPageSpan.Builder
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

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

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

setTableBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setTableBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock value)

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setTableBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock.Builder builderForValue)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setTableBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock.Builder builderForValue)

Block consisting of table content/structure.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock table_block = 3;

Parameter
Name Description
builderForValue Document.DocumentLayout.DocumentLayoutBlock.LayoutTableBlock.Builder
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setTextBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock value)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setTextBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock value)

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Parameter
Name Description
value Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setTextBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock.Builder builderForValue)

public Document.DocumentLayout.DocumentLayoutBlock.Builder setTextBlock(Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock.Builder builderForValue)

Block consisting of text content.

.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock text_block = 2;

Parameter
Name Description
builderForValue Document.DocumentLayout.DocumentLayoutBlock.LayoutTextBlock.Builder
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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