Class protos.google.cloud.documentai.v1.DocumentProcessorService (8.12.0)

Represents a DocumentProcessorService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.documentai.v1.DocumentProcessorService

Package

@google-cloud/documentai

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DocumentProcessorService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchProcessDocuments(request, callback)

public batchProcessDocuments(request: google.cloud.documentai.v1.IBatchProcessRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocumentsCallback): void;

Calls BatchProcessDocuments.

Parameters
Name Description
request IBatchProcessRequest

BatchProcessRequest message or plain object
callback BatchProcessDocumentsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

batchProcessDocuments(request)

public batchProcessDocuments(request: google.cloud.documentai.v1.IBatchProcessRequest): Promise<google.longrunning.Operation>;

Calls BatchProcessDocuments.

Parameter
Name Description
request IBatchProcessRequest

BatchProcessRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DocumentProcessorService;

Creates new DocumentProcessorService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
DocumentProcessorService

RPC service. Useful where requests and/or responses are streamed.

createProcessor(request, callback)

public createProcessor(request: google.cloud.documentai.v1.ICreateProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.CreateProcessorCallback): void;

Calls CreateProcessor.

Parameters
Name Description
request ICreateProcessorRequest

CreateProcessorRequest message or plain object
callback CreateProcessorCallback

Node-style callback called with the error, if any, and Processor
Returns
Type Description
void

createProcessor(request)

public createProcessor(request: google.cloud.documentai.v1.ICreateProcessorRequest): Promise<google.cloud.documentai.v1.Processor>;

Calls CreateProcessor.

Parameter
Name Description
request ICreateProcessorRequest

CreateProcessorRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.Processor>

Promise

deleteProcessor(request, callback)

public deleteProcessor(request: google.cloud.documentai.v1.IDeleteProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorCallback): void;

Calls DeleteProcessor.

Parameters
Name Description
request IDeleteProcessorRequest

DeleteProcessorRequest message or plain object
callback DeleteProcessorCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteProcessor(request)

public deleteProcessor(request: google.cloud.documentai.v1.IDeleteProcessorRequest): Promise<google.longrunning.Operation>;

Calls DeleteProcessor.

Parameter
Name Description
request IDeleteProcessorRequest

DeleteProcessorRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteProcessorVersion(request, callback)

public deleteProcessorVersion(request: google.cloud.documentai.v1.IDeleteProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersionCallback): void;

Calls DeleteProcessorVersion.

Parameters
Name Description
request IDeleteProcessorVersionRequest

DeleteProcessorVersionRequest message or plain object
callback DeleteProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteProcessorVersion(request)

public deleteProcessorVersion(request: google.cloud.documentai.v1.IDeleteProcessorVersionRequest): Promise<google.longrunning.Operation>;

Calls DeleteProcessorVersion.

Parameter
Name Description
request IDeleteProcessorVersionRequest

DeleteProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deployProcessorVersion(request, callback)

public deployProcessorVersion(request: google.cloud.documentai.v1.IDeployProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersionCallback): void;

Calls DeployProcessorVersion.

Parameters
Name Description
request IDeployProcessorVersionRequest

DeployProcessorVersionRequest message or plain object
callback DeployProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deployProcessorVersion(request)

public deployProcessorVersion(request: google.cloud.documentai.v1.IDeployProcessorVersionRequest): Promise<google.longrunning.Operation>;

Calls DeployProcessorVersion.

Parameter
Name Description
request IDeployProcessorVersionRequest

DeployProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

disableProcessor(request, callback)

public disableProcessor(request: google.cloud.documentai.v1.IDisableProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DisableProcessorCallback): void;

Calls DisableProcessor.

Parameters
Name Description
request IDisableProcessorRequest

DisableProcessorRequest message or plain object
callback DisableProcessorCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

disableProcessor(request)

public disableProcessor(request: google.cloud.documentai.v1.IDisableProcessorRequest): Promise<google.longrunning.Operation>;

Calls DisableProcessor.

Parameter
Name Description
request IDisableProcessorRequest

DisableProcessorRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

enableProcessor(request, callback)

public enableProcessor(request: google.cloud.documentai.v1.IEnableProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.EnableProcessorCallback): void;

Calls EnableProcessor.

Parameters
Name Description
request IEnableProcessorRequest

EnableProcessorRequest message or plain object
callback EnableProcessorCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

enableProcessor(request)

public enableProcessor(request: google.cloud.documentai.v1.IEnableProcessorRequest): Promise<google.longrunning.Operation>;

Calls EnableProcessor.

Parameter
Name Description
request IEnableProcessorRequest

EnableProcessorRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

evaluateProcessorVersion(request, callback)

public evaluateProcessorVersion(request: google.cloud.documentai.v1.IEvaluateProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersionCallback): void;

Calls EvaluateProcessorVersion.

Parameters
Name Description
request IEvaluateProcessorVersionRequest

EvaluateProcessorVersionRequest message or plain object
callback EvaluateProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

evaluateProcessorVersion(request)

public evaluateProcessorVersion(request: google.cloud.documentai.v1.IEvaluateProcessorVersionRequest): Promise<google.longrunning.Operation>;

Calls EvaluateProcessorVersion.

Parameter
Name Description
request IEvaluateProcessorVersionRequest

EvaluateProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

fetchProcessorTypes(request, callback)

public fetchProcessorTypes(request: google.cloud.documentai.v1.IFetchProcessorTypesRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypesCallback): void;

Calls FetchProcessorTypes.

Parameters
Name Description
request IFetchProcessorTypesRequest

FetchProcessorTypesRequest message or plain object
callback FetchProcessorTypesCallback

Node-style callback called with the error, if any, and FetchProcessorTypesResponse
Returns
Type Description
void

fetchProcessorTypes(request)

public fetchProcessorTypes(request: google.cloud.documentai.v1.IFetchProcessorTypesRequest): Promise<google.cloud.documentai.v1.FetchProcessorTypesResponse>;

Calls FetchProcessorTypes.

Parameter
Name Description
request IFetchProcessorTypesRequest

FetchProcessorTypesRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.FetchProcessorTypesResponse>

Promise

getEvaluation(request, callback)

public getEvaluation(request: google.cloud.documentai.v1.IGetEvaluationRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetEvaluationCallback): void;

Calls GetEvaluation.

Parameters
Name Description
request IGetEvaluationRequest

GetEvaluationRequest message or plain object
callback GetEvaluationCallback

Node-style callback called with the error, if any, and Evaluation
</
Returns
Type Description