Class Document.ChunkedDocument.Chunk (2.52.0) 

public static final class Document.ChunkedDocument.Chunk extends GeneratedMessageV3 implements Document.ChunkedDocument.ChunkOrBuilder

Represents a chunk.

Protobuf type google.cloud.documentai.v1.Document.ChunkedDocument.Chunk

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.ChunkedDocument.Chunk

Static Fields

CHUNK_ID_FIELD_NUMBER

public static final int CHUNK_ID_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int

PAGE_FOOTERS_FIELD_NUMBER

public static final int PAGE_FOOTERS_FIELD_NUMBER
Field Value
Type Description
int

PAGE_HEADERS_FIELD_NUMBER

public static final int PAGE_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SPAN_FIELD_NUMBER

public static final int PAGE_SPAN_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_BLOCK_IDS_FIELD_NUMBER

public static final int SOURCE_BLOCK_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.ChunkedDocument.Chunk getDefaultInstance()
Returns
Type Description
Document.ChunkedDocument.Chunk

getDescriptor()

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

newBuilder()

public static Document.ChunkedDocument.Chunk.Builder newBuilder()
Returns
Type Description
Document.ChunkedDocument.Chunk.Builder

newBuilder(Document.ChunkedDocument.Chunk prototype)

public static Document.ChunkedDocument.Chunk.Builder newBuilder(Document.ChunkedDocument.Chunk prototype)
Parameter
Name Description
prototype Document.ChunkedDocument.Chunk
Returns
Type Description
Document.ChunkedDocument.Chunk.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Document.ChunkedDocument.Chunk> parser()
Returns
Type Description
Parser<Chunk>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getChunkId()

public String getChunkId()

ID of the chunk.

string chunk_id = 1;

Returns
Type Description
String

The chunkId.

getChunkIdBytes()

public ByteString getChunkIdBytes()

ID of the chunk.

string chunk_id = 1;

Returns
Type Description
ByteString

The bytes for chunkId.

getContent()

public String getContent()

Text content of the chunk.

string content = 3;

Returns
Type Description
String

The content.

getContentBytes()

public ByteString getContentBytes()

Text content of the chunk.

string content = 3;

Returns
Type Description
ByteString

The bytes for content.

getDefaultInstanceForType()

public Document.ChunkedDocument.Chunk getDefaultInstanceForType()
Returns
Type Description
Document.ChunkedDocument.Chunk

getPageFooters(int index)

public Document.ChunkedDocument.Chunk.ChunkPageFooter getPageFooters(int index)

Page footers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;

Parameter
Name Description
index int
Returns
Type Description
Document.ChunkedDocument.Chunk.ChunkPageFooter

getPageFootersCount()

public int getPageFootersCount()

Page footers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;

Returns
Type Description
int

getPageFootersList()

public List<Document.ChunkedDocument.Chunk.ChunkPageFooter> getPageFootersList()

Page footers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;

Returns
Type Description
List<ChunkPageFooter>

getPageFootersOrBuilder(int index)

public Document.ChunkedDocument.Chunk.ChunkPageFooterOrBuilder getPageFootersOrBuilder(int index)

Page footers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;

Parameter
Name Description
index int
Returns
Type Description
Document.ChunkedDocument.Chunk.ChunkPageFooterOrBuilder

getPageFootersOrBuilderList()

public List<? extends Document.ChunkedDocument.Chunk.ChunkPageFooterOrBuilder> getPageFootersOrBuilderList()

Page footers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooter page_footers = 6;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageFooterOrBuilder>

getPageHeaders(int index)

public Document.ChunkedDocument.Chunk.ChunkPageHeader getPageHeaders(int index)

Page headers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;

Parameter
Name Description
index int
Returns
Type Description
Document.ChunkedDocument.Chunk.ChunkPageHeader

getPageHeadersCount()

public int getPageHeadersCount()

Page headers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;

Returns
Type Description
int

getPageHeadersList()

public List<Document.ChunkedDocument.Chunk.ChunkPageHeader> getPageHeadersList()

Page headers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;

Returns
Type Description
List<ChunkPageHeader>

getPageHeadersOrBuilder(int index)

public Document.ChunkedDocument.Chunk.ChunkPageHeaderOrBuilder getPageHeadersOrBuilder(int index)

Page headers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;

Parameter
Name Description
index int
Returns
Type Description
Document.ChunkedDocument.Chunk.ChunkPageHeaderOrBuilder

getPageHeadersOrBuilderList()

public List<? extends Document.ChunkedDocument.Chunk.ChunkPageHeaderOrBuilder> getPageHeadersOrBuilderList()

Page headers associated with the chunk.

repeated .google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeader page_headers = 5;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageHeaderOrBuilder>

getPageSpan()

public Document.ChunkedDocument.Chunk.ChunkPageSpan getPageSpan()

Page span of the chunk.

.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4;

Returns
Type Description
Document.ChunkedDocument.Chunk.ChunkPageSpan

The pageSpan.

getPageSpanOrBuilder()

public Document.ChunkedDocument.Chunk.ChunkPageSpanOrBuilder getPageSpanOrBuilder()

Page span of the chunk.

.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4;

Returns
Type Description
Document.ChunkedDocument.Chunk.ChunkPageSpanOrBuilder

getParserForType()

public Parser<Document.ChunkedDocument.Chunk> getParserForType()
Returns
Type Description
Parser<Chunk>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceBlockIds(int index)

public String getSourceBlockIds(int index)

Unused.

repeated string source_block_ids = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The sourceBlockIds at the given index.

getSourceBlockIdsBytes(int index)

public ByteString getSourceBlockIdsBytes(int index)

Unused.

repeated string source_block_ids = 2;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the sourceBlockIds at the given index.

getSourceBlockIdsCount()

public int getSourceBlockIdsCount()

Unused.

repeated string source_block_ids = 2;

Returns
Type Description
int

The count of sourceBlockIds.

getSourceBlockIdsList()

public ProtocolStringList getSourceBlockIdsList()

Unused.

repeated string source_block_ids = 2;

Returns
Type Description
ProtocolStringList

A list containing the sourceBlockIds.

hasPageSpan()

public boolean hasPageSpan()

Page span of the chunk.

.google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.ChunkPageSpan page_span = 4;

Returns
Type Description
boolean

Whether the pageSpan 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.ChunkedDocument.Chunk.Builder newBuilderForType()
Returns
Type Description
Document.ChunkedDocument.Chunk.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.ChunkedDocument.Chunk.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.ChunkedDocument.Chunk.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.ChunkedDocument.Chunk.Builder toBuilder()
Returns
Type Description
Document.ChunkedDocument.Chunk.Builder

writeTo(CodedOutputStream output)

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