Class protos.google.cloud.documentai.v1beta3.DocumentProcessorService (3.2.1)

Represents a DocumentProcessorService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.documentai.v1beta3.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.v1beta3.IBatchProcessRequest, callback: google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocumentsCallback): void;

Calls BatchProcessDocuments.

Parameters
Name Description
request IBatchProcessRequest

BatchProcessRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocumentsCallback

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

batchProcessDocuments(request)

public batchProcessDocuments(request: google.cloud.documentai.v1beta3.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.v1beta3.ICreateProcessorRequest, callback: google.cloud.documentai.v1beta3.DocumentProcessorService.CreateProcessorCallback): void;

Calls CreateProcessor.

Parameters
Name Description
request ICreateProcessorRequest

CreateProcessorRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.CreateProcessorCallback

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

createProcessor(request)

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

Calls CreateProcessor.

Parameter
Name Description
request ICreateProcessorRequest

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

Promise

deleteProcessor(request, callback)

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

Calls DeleteProcessor.

Parameters
Name Description
request IDeleteProcessorRequest

DeleteProcessorRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessorCallback

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

deleteProcessor(request)

public deleteProcessor(request: google.cloud.documentai.v1beta3.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

disableProcessor(request, callback)

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

Calls DisableProcessor.

Parameters
Name Description
request IDisableProcessorRequest

DisableProcessorRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.DisableProcessorCallback

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

disableProcessor(request)

public disableProcessor(request: google.cloud.documentai.v1beta3.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.v1beta3.IEnableProcessorRequest, callback: google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessorCallback): void;

Calls EnableProcessor.

Parameters
Name Description
request google.cloud.documentai.v1beta3.IEnableProcessorRequest

EnableProcessorRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessorCallback

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

enableProcessor(request)

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

Calls EnableProcessor.

Parameter
Name Description
request google.cloud.documentai.v1beta3.IEnableProcessorRequest

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

Promise

fetchProcessorTypes(request, callback)

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

Calls FetchProcessorTypes.

Parameters
Name Description
request IFetchProcessorTypesRequest

FetchProcessorTypesRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypesCallback

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

fetchProcessorTypes(request)

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

Calls FetchProcessorTypes.

Parameter
Name Description
request IFetchProcessorTypesRequest

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

Promise

listProcessors(request, callback)

public listProcessors(request: google.cloud.documentai.v1beta3.IListProcessorsRequest, callback: google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorsCallback): void;

Calls ListProcessors.

Parameters
Name Description
request IListProcessorsRequest

ListProcessorsRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorsCallback

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

listProcessors(request)

public listProcessors(request: google.cloud.documentai.v1beta3.IListProcessorsRequest): Promise<google.cloud.documentai.v1beta3.ListProcessorsResponse>;

Calls ListProcessors.

Parameter
Name Description
request IListProcessorsRequest

ListProcessorsRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1beta3.ListProcessorsResponse>

Promise

processDocument(request, callback)

public processDocument(request: google.cloud.documentai.v1beta3.IProcessRequest, callback: google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocumentCallback): void;

Calls ProcessDocument.

Parameters
Name Description
request IProcessRequest

ProcessRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocumentCallback

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

processDocument(request)

public processDocument(request: google.cloud.documentai.v1beta3.IProcessRequest): Promise<google.cloud.documentai.v1beta3.ProcessResponse>;

Calls ProcessDocument.

Parameter
Name Description
request IProcessRequest

ProcessRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1beta3.ProcessResponse>

Promise

reviewDocument(request, callback)

public reviewDocument(request: google.cloud.documentai.v1beta3.IReviewDocumentRequest, callback: google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocumentCallback): void;

Calls ReviewDocument.

Parameters
Name Description
request IReviewDocumentRequest

ReviewDocumentRequest message or plain object
callback google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocumentCallback

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

reviewDocument(request)

public reviewDocument(request: google.cloud.documentai.v1beta3.IReviewDocumentRequest): Promise<google.longrunning.Operation>;

Calls ReviewDocument.

Parameter
Name Description
request IReviewDocumentRequest

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

Promise