Represents a DocumentProcessorService
Inheritance
$protobuf.rpc.Service > protos.google.cloud.documentai.v1.DocumentProcessorServicePackage
@google-cloud/documentaiConstructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
Constructs a new DocumentProcessorService service.
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.
Name | Description |
request |
IBatchProcessRequest
BatchProcessRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocumentsCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
batchProcessDocuments(request)
public batchProcessDocuments(request: google.cloud.documentai.v1.IBatchProcessRequest): Promise<google.longrunning.Operation>;
Calls BatchProcessDocuments.
Name | Description |
request |
IBatchProcessRequest
BatchProcessRequest message or plain object |
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.
Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
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.
Name | Description |
request |
ICreateProcessorRequest
CreateProcessorRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.CreateProcessorCallback
Node-style callback called with the error, if any, and Processor |
Type | Description |
void |
createProcessor(request)
public createProcessor(request: google.cloud.documentai.v1.ICreateProcessorRequest): Promise<google.cloud.documentai.v1.Processor>;
Calls CreateProcessor.
Name | Description |
request |
ICreateProcessorRequest
CreateProcessorRequest message or plain object |
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.
Name | Description |
request |
IDeleteProcessorRequest
DeleteProcessorRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
deleteProcessor(request)
public deleteProcessor(request: google.cloud.documentai.v1.IDeleteProcessorRequest): Promise<google.longrunning.Operation>;
Calls DeleteProcessor.
Name | Description |
request |
IDeleteProcessorRequest
DeleteProcessorRequest message or plain object |
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.
Name | Description |
request |
google.cloud.documentai.v1.IDeleteProcessorVersionRequest
DeleteProcessorVersionRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersionCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
deleteProcessorVersion(request)
public deleteProcessorVersion(request: google.cloud.documentai.v1.IDeleteProcessorVersionRequest): Promise<google.longrunning.Operation>;
Calls DeleteProcessorVersion.
Name | Description |
request |
google.cloud.documentai.v1.IDeleteProcessorVersionRequest
DeleteProcessorVersionRequest message or plain object |
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.
Name | Description |
request |
IDeployProcessorVersionRequest
DeployProcessorVersionRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersionCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
deployProcessorVersion(request)
public deployProcessorVersion(request: google.cloud.documentai.v1.IDeployProcessorVersionRequest): Promise<google.longrunning.Operation>;
Calls DeployProcessorVersion.
Name | Description |
request |
IDeployProcessorVersionRequest
DeployProcessorVersionRequest message or plain object |
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.
Name | Description |
request |
IDisableProcessorRequest
DisableProcessorRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.DisableProcessorCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
disableProcessor(request)
public disableProcessor(request: google.cloud.documentai.v1.IDisableProcessorRequest): Promise<google.longrunning.Operation>;
Calls DisableProcessor.
Name | Description |
request |
IDisableProcessorRequest
DisableProcessorRequest message or plain object |
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.
Name | Description |
request |
IEnableProcessorRequest
EnableProcessorRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.EnableProcessorCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
enableProcessor(request)
public enableProcessor(request: google.cloud.documentai.v1.IEnableProcessorRequest): Promise<google.longrunning.Operation>;
Calls EnableProcessor.
Name | Description |
request |
IEnableProcessorRequest
EnableProcessorRequest message or plain object |
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.
Name | Description |
request |
google.cloud.documentai.v1.IFetchProcessorTypesRequest
FetchProcessorTypesRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypesCallback
Node-style callback called with the error, if any, and FetchProcessorTypesResponse |
Type | Description |
void |
fetchProcessorTypes(request)
public fetchProcessorTypes(request: google.cloud.documentai.v1.IFetchProcessorTypesRequest): Promise<google.cloud.documentai.v1.FetchProcessorTypesResponse>;
Calls FetchProcessorTypes.
Name | Description |
request |
google.cloud.documentai.v1.IFetchProcessorTypesRequest
FetchProcessorTypesRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.FetchProcessorTypesResponse> | Promise |
getProcessor(request, callback)
public getProcessor(request: google.cloud.documentai.v1.IGetProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetProcessorCallback): void;
Calls GetProcessor.
Name | Description |
request |
IGetProcessorRequest
GetProcessorRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.GetProcessorCallback
Node-style callback called with the error, if any, and Processor |
Type | Description |
void |
getProcessor(request)
public getProcessor(request: google.cloud.documentai.v1.IGetProcessorRequest): Promise<google.cloud.documentai.v1.Processor>;
Calls GetProcessor.
Name | Description |
request |
IGetProcessorRequest
GetProcessorRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.Processor> | Promise |
getProcessorType(request, callback)
public getProcessorType(request: google.cloud.documentai.v1.IGetProcessorTypeRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetProcessorTypeCallback): void;
Calls GetProcessorType.
Name | Description |
request |
IGetProcessorTypeRequest
GetProcessorTypeRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.GetProcessorTypeCallback
Node-style callback called with the error, if any, and ProcessorType |
Type | Description |
void |
getProcessorType(request)
public getProcessorType(request: google.cloud.documentai.v1.IGetProcessorTypeRequest): Promise<google.cloud.documentai.v1.ProcessorType>;
Calls GetProcessorType.
Name | Description |
request |
IGetProcessorTypeRequest
GetProcessorTypeRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.ProcessorType> | Promise |
getProcessorVersion(request, callback)
public getProcessorVersion(request: google.cloud.documentai.v1.IGetProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersionCallback): void;
Calls GetProcessorVersion.
Name | Description |
request |
IGetProcessorVersionRequest
GetProcessorVersionRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersionCallback
Node-style callback called with the error, if any, and ProcessorVersion |
Type | Description |
void |
getProcessorVersion(request)
public getProcessorVersion(request: google.cloud.documentai.v1.IGetProcessorVersionRequest): Promise<google.cloud.documentai.v1.ProcessorVersion>;
Calls GetProcessorVersion.
Name | Description |
request |
IGetProcessorVersionRequest
GetProcessorVersionRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.ProcessorVersion> | Promise |
listProcessors(request, callback)
public listProcessors(request: google.cloud.documentai.v1.IListProcessorsRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ListProcessorsCallback): void;
Calls ListProcessors.
Name | Description |
request |
google.cloud.documentai.v1.IListProcessorsRequest
ListProcessorsRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.ListProcessorsCallback
Node-style callback called with the error, if any, and ListProcessorsResponse |
Type | Description |
void |
listProcessors(request)
public listProcessors(request: google.cloud.documentai.v1.IListProcessorsRequest): Promise<google.cloud.documentai.v1.ListProcessorsResponse>;
Calls ListProcessors.
Name | Description |
request |
google.cloud.documentai.v1.IListProcessorsRequest
ListProcessorsRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.ListProcessorsResponse> | Promise |
listProcessorTypes(request, callback)
public listProcessorTypes(request: google.cloud.documentai.v1.IListProcessorTypesRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypesCallback): void;
Calls ListProcessorTypes.
Name | Description |
request |
google.cloud.documentai.v1.IListProcessorTypesRequest
ListProcessorTypesRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypesCallback
Node-style callback called with the error, if any, and ListProcessorTypesResponse |
Type | Description |
void |
listProcessorTypes(request)
public listProcessorTypes(request: google.cloud.documentai.v1.IListProcessorTypesRequest): Promise<google.cloud.documentai.v1.ListProcessorTypesResponse>;
Calls ListProcessorTypes.
Name | Description |
request |
google.cloud.documentai.v1.IListProcessorTypesRequest
ListProcessorTypesRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.ListProcessorTypesResponse> | Promise |
listProcessorVersions(request, callback)
public listProcessorVersions(request: google.cloud.documentai.v1.IListProcessorVersionsRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ListProcessorVersionsCallback): void;
Calls ListProcessorVersions.
Name | Description |
request |
IListProcessorVersionsRequest
ListProcessorVersionsRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.ListProcessorVersionsCallback
Node-style callback called with the error, if any, and ListProcessorVersionsResponse |
Type | Description |
void |
listProcessorVersions(request)
public listProcessorVersions(request: google.cloud.documentai.v1.IListProcessorVersionsRequest): Promise<google.cloud.documentai.v1.ListProcessorVersionsResponse>;
Calls ListProcessorVersions.
Name | Description |
request |
IListProcessorVersionsRequest
ListProcessorVersionsRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.ListProcessorVersionsResponse> | Promise |
processDocument(request, callback)
public processDocument(request: google.cloud.documentai.v1.IProcessRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ProcessDocumentCallback): void;
Calls ProcessDocument.
Name | Description |
request |
IProcessRequest
ProcessRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.ProcessDocumentCallback
Node-style callback called with the error, if any, and ProcessResponse |
Type | Description |
void |
processDocument(request)
public processDocument(request: google.cloud.documentai.v1.IProcessRequest): Promise<google.cloud.documentai.v1.ProcessResponse>;
Calls ProcessDocument.
Name | Description |
request |
IProcessRequest
ProcessRequest message or plain object |
Type | Description |
Promise<google.cloud.documentai.v1.ProcessResponse> | Promise |
reviewDocument(request, callback)
public reviewDocument(request: google.cloud.documentai.v1.IReviewDocumentRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ReviewDocumentCallback): void;
Calls ReviewDocument.
Name | Description |
request |
google.cloud.documentai.v1.IReviewDocumentRequest
ReviewDocumentRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.ReviewDocumentCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
reviewDocument(request)
public reviewDocument(request: google.cloud.documentai.v1.IReviewDocumentRequest): Promise<google.longrunning.Operation>;
Calls ReviewDocument.
Name | Description |
request |
google.cloud.documentai.v1.IReviewDocumentRequest
ReviewDocumentRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |
setDefaultProcessorVersion(request, callback)
public setDefaultProcessorVersion(request: google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersionCallback): void;
Calls SetDefaultProcessorVersion.
Name | Description |
request |
google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest
SetDefaultProcessorVersionRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersionCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
setDefaultProcessorVersion(request)
public setDefaultProcessorVersion(request: google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest): Promise<google.longrunning.Operation>;
Calls SetDefaultProcessorVersion.
Name | Description |
request |
google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest
SetDefaultProcessorVersionRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |
undeployProcessorVersion(request, callback)
public undeployProcessorVersion(request: google.cloud.documentai.v1.IUndeployProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersionCallback): void;
Calls UndeployProcessorVersion.
Name | Description |
request |
google.cloud.documentai.v1.IUndeployProcessorVersionRequest
UndeployProcessorVersionRequest message or plain object |
callback |
google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersionCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
undeployProcessorVersion(request)
public undeployProcessorVersion(request: google.cloud.documentai.v1.IUndeployProcessorVersionRequest): Promise<google.longrunning.Operation>;
Calls UndeployProcessorVersion.
Name | Description |
request |
google.cloud.documentai.v1.IUndeployProcessorVersionRequest
UndeployProcessorVersionRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |