Class protos.google.cloud.documentai.v1beta3.RawDocument (3.0.2)

Represents a RawDocument.

Package

@google-cloud/documentai!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta3.IRawDocument);

Constructs a new RawDocument.

Parameter

Name	Description
properties	`IRawDocument` Properties to set

Properties

content

public content: (Uint8Array|string);

RawDocument content.

Property Value

Type	Description
(Uint8Array\|string)

mimeType

public mimeType: string;

RawDocument mimeType.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.IRawDocument): google.cloud.documentai.v1beta3.RawDocument;

Creates a new RawDocument instance using the specified properties.

Parameter

Name	Description
properties	`IRawDocument` Properties to set

Returns

Type	Description
google.cloud.documentai.v1beta3.RawDocument	RawDocument instance

decode(reader, length)

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

Decodes a RawDocument 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.v1beta3.RawDocument	RawDocument

decodeDelimited(reader)

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

Decodes a RawDocument 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.v1beta3.RawDocument	RawDocument

encode(message, writer)

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

Encodes the specified RawDocument message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IRawDocument` RawDocument 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.v1beta3.RawDocument;

Creates a RawDocument 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.v1beta3.RawDocument	RawDocument

toJSON()

public toJSON(): { [k: string]: any };

Converts this RawDocument to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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