Represents a Chunk.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1.Document.ChunkedDocument.IChunk);
Constructs a new Chunk.
Parameter | |
---|---|
Name | Description |
properties |
IChunk
Properties to set |
Properties
chunkId
public chunkId: string;
Chunk chunkId.
content
public content: string;
Chunk content.
pageFooters
public pageFooters: google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.IChunkPageFooter[];
Chunk pageFooters.
pageHeaders
public pageHeaders: google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.IChunkPageHeader[];
Chunk pageHeaders.
pageSpan
public pageSpan?: (google.cloud.documentai.v1.Document.ChunkedDocument.Chunk.IChunkPageSpan|null);
Chunk pageSpan.
sourceBlockIds
public sourceBlockIds: string[];
Chunk sourceBlockIds.
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1.Document.ChunkedDocument.IChunk): google.cloud.documentai.v1.Document.ChunkedDocument.Chunk;
Creates a new Chunk instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IChunk
Properties to set |
Returns | |
---|---|
Type | Description |
Chunk |
Chunk instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1.Document.ChunkedDocument.Chunk;
Decodes a Chunk message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
Chunk |
Chunk |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.Document.ChunkedDocument.Chunk;
Decodes a Chunk message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Chunk |
Chunk |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1.Document.ChunkedDocument.IChunk, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Chunk message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IChunk
Chunk message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.documentai.v1.Document.ChunkedDocument.IChunk, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Chunk message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IChunk
Chunk message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1.Document.ChunkedDocument.Chunk;
Creates a Chunk message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
Chunk |
Chunk |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Chunk
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Chunk to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.documentai.v1.Document.ChunkedDocument.Chunk, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Chunk message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Chunk
Chunk |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Chunk message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|