Constructor
new DocumentProcessorService(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new DocumentProcessorService service.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DocumentProcessorService}
Creates new DocumentProcessorService service using the specified rpc implementation.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
| Type | Description |
|---|---|
| DocumentProcessorService |
RPC service. Useful where requests and/or responses are streamed. |
batchProcessDocuments(request, callback) → {undefined}
Calls BatchProcessDocuments.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
batchProcessDocuments(request) → {Promise.<google.longrunning.Operation>}
Calls BatchProcessDocuments.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IBatchProcessRequest |
BatchProcessRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
createProcessor(request, callback) → {undefined}
Calls CreateProcessor.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
createProcessor(request) → {Promise.<google.cloud.documentai.v1beta3.Processor>}
Calls CreateProcessor.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.ICreateProcessorRequest |
CreateProcessorRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.documentai.v1beta3.Processor> |
Promise |
deleteProcessor(request, callback) → {undefined}
Calls DeleteProcessor.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
deleteProcessor(request) → {Promise.<google.longrunning.Operation>}
Calls DeleteProcessor.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IDeleteProcessorRequest |
DeleteProcessorRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
disableProcessor(request, callback) → {undefined}
Calls DisableProcessor.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
disableProcessor(request) → {Promise.<google.longrunning.Operation>}
Calls DisableProcessor.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IDisableProcessorRequest |
DisableProcessorRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
enableProcessor(request, callback) → {undefined}
Calls EnableProcessor.
Parameters:
| Name | Type | 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 |
|---|---|
| undefined |
enableProcessor(request) → {Promise.<google.longrunning.Operation>}
Calls EnableProcessor.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IEnableProcessorRequest |
EnableProcessorRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
fetchProcessorTypes(request, callback) → {undefined}
Calls FetchProcessorTypes.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
fetchProcessorTypes(request) → {Promise.<google.cloud.documentai.v1beta3.FetchProcessorTypesResponse>}
Calls FetchProcessorTypes.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest |
FetchProcessorTypesRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.documentai.v1beta3.FetchProcessorTypesResponse> |
Promise |
listProcessors(request, callback) → {undefined}
Calls ListProcessors.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
listProcessors(request) → {Promise.<google.cloud.documentai.v1beta3.ListProcessorsResponse>}
Calls ListProcessors.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IListProcessorsRequest |
ListProcessorsRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.documentai.v1beta3.ListProcessorsResponse> |
Promise |
processDocument(request, callback) → {undefined}
Calls ProcessDocument.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
processDocument(request) → {Promise.<google.cloud.documentai.v1beta3.ProcessResponse>}
Calls ProcessDocument.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IProcessRequest |
ProcessRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.documentai.v1beta3.ProcessResponse> |
Promise |
reviewDocument(request, callback) → {undefined}
Calls ReviewDocument.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.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 |
|---|---|
| undefined |
reviewDocument(request) → {Promise.<google.longrunning.Operation>}
Calls ReviewDocument.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.documentai.v1beta3.IReviewDocumentRequest |
ReviewDocumentRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
Type Definitions
BatchProcessDocumentsCallback(error, responseopt)
Callback as used by batchProcessDocuments.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
CreateProcessorCallback(error, responseopt)
Callback as used by createProcessor.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.documentai.v1beta3.Processor |
<optional> |
Processor |
DeleteProcessorCallback(error, responseopt)
Callback as used by deleteProcessor.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
DisableProcessorCallback(error, responseopt)
Callback as used by disableProcessor.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
EnableProcessorCallback(error, responseopt)
Callback as used by enableProcessor.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
FetchProcessorTypesCallback(error, responseopt)
Callback as used by fetchProcessorTypes.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.documentai.v1beta3.FetchProcessorTypesResponse |
<optional> |
FetchProcessorTypesResponse |
ListProcessorsCallback(error, responseopt)
Callback as used by listProcessors.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.documentai.v1beta3.ListProcessorsResponse |
<optional> |
ListProcessorsResponse |
ProcessDocumentCallback(error, responseopt)
Callback as used by processDocument.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.documentai.v1beta3.ProcessResponse |
<optional> |
ProcessResponse |
ReviewDocumentCallback(error, responseopt)
Callback as used by reviewDocument.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |