public static final class Document.DocumentLayout extends GeneratedMessage implements Document.DocumentLayoutOrBuilderRepresents the parsed layout of a document as a collection of blocks that the document is divided into.
Protobuf type google.cloud.documentai.v1.Document.DocumentLayout
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Document.DocumentLayoutImplements
Document.DocumentLayoutOrBuilderStatic Fields
BLOCKS_FIELD_NUMBER
public static final int BLOCKS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Document.DocumentLayout getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Document.DocumentLayout.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout.Builder |
|
newBuilder(Document.DocumentLayout prototype)
public static Document.DocumentLayout.Builder newBuilder(Document.DocumentLayout prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Document.DocumentLayout |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout.Builder |
|
parseDelimitedFrom(InputStream input)
public static Document.DocumentLayout parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.DocumentLayout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Document.DocumentLayout parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document.DocumentLayout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Document.DocumentLayout parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document.DocumentLayout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Document.DocumentLayout parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.DocumentLayout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Document.DocumentLayout parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Document.DocumentLayout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Document.DocumentLayout parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document.DocumentLayout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Document.DocumentLayout> parser()| Returns | |
|---|---|
| Type | Description |
Parser<DocumentLayout> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBlocks(int index)
public Document.DocumentLayout.DocumentLayoutBlock getBlocks(int index)List of blocks in the document.
repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout.DocumentLayoutBlock |
|
getBlocksCount()
public int getBlocksCount()List of blocks in the document.
repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1;
| Returns | |
|---|---|
| Type | Description |
int |
|
getBlocksList()
public List<Document.DocumentLayout.DocumentLayoutBlock> getBlocksList()List of blocks in the document.
repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1;
| Returns | |
|---|---|
| Type | Description |
List<DocumentLayoutBlock> |
|
getBlocksOrBuilder(int index)
public Document.DocumentLayout.DocumentLayoutBlockOrBuilder getBlocksOrBuilder(int index)List of blocks in the document.
repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout.DocumentLayoutBlockOrBuilder |
|
getBlocksOrBuilderList()
public List<? extends Document.DocumentLayout.DocumentLayoutBlockOrBuilder> getBlocksOrBuilderList()List of blocks in the document.
repeated .google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlock blocks = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1.Document.DocumentLayout.DocumentLayoutBlockOrBuilder> |
|
getDefaultInstanceForType()
public Document.DocumentLayout getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout |
|
getParserForType()
public Parser<Document.DocumentLayout> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<DocumentLayout> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Document.DocumentLayout.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Document.DocumentLayout.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout.Builder |
|
toBuilder()
public Document.DocumentLayout.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Document.DocumentLayout.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|