Class Document.DocumentLayout.DocumentLayoutBlock (2.58.0)

public static final class Document.DocumentLayout.DocumentLayoutBlock extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.DocumentLayout.DocumentLayoutBlock

Static Fields

BLOCK_ID_FIELD_NUMBER

public static final int BLOCK_ID_FIELD_NUMBER
Field Value
Type Description
int

LIST_BLOCK_FIELD_NUMBER

public static final int LIST_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SPAN_FIELD_NUMBER

public static final int PAGE_SPAN_FIELD_NUMBER
Field Value
Type Description
int

TABLE_BLOCK_FIELD_NUMBER

public static final int TABLE_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

TEXT_BLOCK_FIELD_NUMBER

public static final int TEXT_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.DocumentLayout.DocumentLayoutBlock getDefaultInstance()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock

getDescriptor()

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

newBuilder()

public static Document.DocumentLayout.DocumentLayoutBlock.Builder newBuilder()
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

newBuilder(Document.DocumentLayout.DocumentLayoutBlock prototype)

public static Document.DocumentLayout.DocumentLayoutBlock.Builder newBuilder(Document.DocumentLayout.DocumentLayoutBlock prototype)
Parameter
Name Description
prototype Document.DocumentLayout.DocumentLayoutBlock
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder

parseDelimitedFrom(InputStream input)

public static Document.DocumentLayout.DocumentLayoutBlock parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.DocumentLayout.DocumentLayoutBlock parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Document.DocumentLayout.DocumentLayoutBlock> parser()
Returns
Type Description
Parser<DocumentLayoutBlock>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

getDefaultInstanceForType()

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

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.

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.

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

getParserForType()

public Parser<Document.DocumentLayout.DocumentLayoutBlock> getParserForType()
Returns
Type Description
Parser<DocumentLayoutBlock>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.DocumentLayout.DocumentLayoutBlock.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.DocumentLayout.DocumentLayoutBlock.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException