Class protos.google.cloud.documentai.v1.Document (0.1.2)

Represents a Document.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.IDocument);

Constructs a new Document.

Parameter

Name	Description
properties	`IDocument` Properties to set

Properties

content

public content?: (Uint8Array|string|null);

Document content.

entities

public entities: google.cloud.documentai.v1.Document.IEntity[];

Document entities.

entityRelations

public entityRelations: google.cloud.documentai.v1.Document.IEntityRelation[];

Document entityRelations.

error

public error?: (google.rpc.IStatus|null);

Document error.

mimeType

public mimeType: string;

Document mimeType.

pages

public pages: google.cloud.documentai.v1.Document.IPage[];

Document pages.

revisions

public revisions: google.cloud.documentai.v1.Document.IRevision[];

Document revisions.

shardInfo

public shardInfo?: (google.cloud.documentai.v1.Document.IShardInfo|null);

Document shardInfo.

source

public source?: ("uri"|"content");

Document source.

text

public text: string;

Document text.

textChanges

public textChanges: google.cloud.documentai.v1.Document.ITextChange[];

Document textChanges.

textStyles

public textStyles: google.cloud.documentai.v1.Document.IStyle[];

Document textStyles.

uri

public uri?: (string|null);

Document uri.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.IDocument): google.cloud.documentai.v1.Document;

Creates a new Document instance using the specified properties.

Parameter

Name	Description
properties	`IDocument` Properties to set

Returns

Type	Description
google.cloud.documentai.v1.Document	Document instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1.Document;

Decodes a Document message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.documentai.v1.Document	Document

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.Document;

Decodes a Document message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.documentai.v1.Document	Document

encode(message, writer)

public static encode(message: google.cloud.documentai.v1.IDocument, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Document message. Does not implicitly messages.

Parameters

Name	Description
message	`IDocument` Document 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.IDocument, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Document message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IDocument` Document 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;

Creates a Document 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
google.cloud.documentai.v1.Document	Document

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Document

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 Document to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1.Document, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Document message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.documentai.v1.Document` Document
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 Document message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not