Class protos.google.cloud.documentai.v1beta1.ProcessDocumentRequest (3.1.0)

Represents a ProcessDocumentRequest.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta1.IProcessDocumentRequest);

Constructs a new ProcessDocumentRequest.

Parameter

Name	Description
properties	`IProcessDocumentRequest` Properties to set

Properties

documentType

public documentType: string;

ProcessDocumentRequest documentType.

entityExtractionParams

public entityExtractionParams?: (google.cloud.documentai.v1beta1.IEntityExtractionParams|null);

ProcessDocumentRequest entityExtractionParams.

formExtractionParams

public formExtractionParams?: (google.cloud.documentai.v1beta1.IFormExtractionParams|null);

ProcessDocumentRequest formExtractionParams.

inputConfig

public inputConfig?: (google.cloud.documentai.v1beta1.IInputConfig|null);

ProcessDocumentRequest inputConfig.

ocrParams

public ocrParams?: (google.cloud.documentai.v1beta1.IOcrParams|null);

ProcessDocumentRequest ocrParams.

outputConfig

public outputConfig?: (google.cloud.documentai.v1beta1.IOutputConfig|null);

ProcessDocumentRequest outputConfig.

tableExtractionParams

public tableExtractionParams?: (google.cloud.documentai.v1beta1.ITableExtractionParams|null);

ProcessDocumentRequest tableExtractionParams.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta1.IProcessDocumentRequest): google.cloud.documentai.v1beta1.ProcessDocumentRequest;

Creates a new ProcessDocumentRequest instance using the specified properties.

Parameter

Name	Description
properties	`IProcessDocumentRequest` Properties to set

Returns

Type	Description
google.cloud.documentai.v1beta1.ProcessDocumentRequest	ProcessDocumentRequest instance

decode(reader, length)

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

Decodes a ProcessDocumentRequest 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.v1beta1.ProcessDocumentRequest	ProcessDocumentRequest

decodeDelimited(reader)

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

Decodes a ProcessDocumentRequest 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.v1beta1.ProcessDocumentRequest	ProcessDocumentRequest

encode(message, writer)

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

Encodes the specified ProcessDocumentRequest message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IProcessDocumentRequest` ProcessDocumentRequest 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.v1beta1.ProcessDocumentRequest;

Creates a ProcessDocumentRequest 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.v1beta1.ProcessDocumentRequest	ProcessDocumentRequest

toJSON()

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

Converts this ProcessDocumentRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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