Constructor
new Operations(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new Operations 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) → {Operations}
Creates new Operations 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 |
---|---|
Operations |
RPC service. Useful where requests and/or responses are streamed. |
cancelOperation(request, callback) → {undefined}
Calls CancelOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.ICancelOperationRequest |
CancelOperationRequest message or plain object |
callback |
google.longrunning.Operations.CancelOperationCallback |
Node-style callback called with the error, if any, and Empty |
Returns:
Type | Description |
---|---|
undefined |
cancelOperation(request) → {Promise.<google.protobuf.Empty>}
Calls CancelOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.ICancelOperationRequest |
CancelOperationRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.protobuf.Empty> |
Promise |
deleteOperation(request, callback) → {undefined}
Calls DeleteOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IDeleteOperationRequest |
DeleteOperationRequest message or plain object |
callback |
google.longrunning.Operations.DeleteOperationCallback |
Node-style callback called with the error, if any, and Empty |
Returns:
Type | Description |
---|---|
undefined |
deleteOperation(request) → {Promise.<google.protobuf.Empty>}
Calls DeleteOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IDeleteOperationRequest |
DeleteOperationRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.protobuf.Empty> |
Promise |
getOperation(request, callback) → {undefined}
Calls GetOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IGetOperationRequest |
GetOperationRequest message or plain object |
callback |
google.longrunning.Operations.GetOperationCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
Type | Description |
---|---|
undefined |
getOperation(request) → {Promise.<google.longrunning.Operation>}
Calls GetOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IGetOperationRequest |
GetOperationRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.longrunning.Operation> |
Promise |
listOperations(request, callback) → {undefined}
Calls ListOperations.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IListOperationsRequest |
ListOperationsRequest message or plain object |
callback |
google.longrunning.Operations.ListOperationsCallback |
Node-style callback called with the error, if any, and ListOperationsResponse |
Returns:
Type | Description |
---|---|
undefined |
listOperations(request) → {Promise.<google.longrunning.ListOperationsResponse>}
Calls ListOperations.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IListOperationsRequest |
ListOperationsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.longrunning.ListOperationsResponse> |
Promise |
waitOperation(request, callback) → {undefined}
Calls WaitOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IWaitOperationRequest |
WaitOperationRequest message or plain object |
callback |
google.longrunning.Operations.WaitOperationCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
Type | Description |
---|---|
undefined |
waitOperation(request) → {Promise.<google.longrunning.Operation>}
Calls WaitOperation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.longrunning.IWaitOperationRequest |
WaitOperationRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.longrunning.Operation> |
Promise |
Type Definitions
CancelOperationCallback(error, responseopt)
Callback as used by cancelOperation.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.protobuf.Empty |
<optional> |
Empty |
DeleteOperationCallback(error, responseopt)
Callback as used by deleteOperation.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.protobuf.Empty |
<optional> |
Empty |
GetOperationCallback(error, responseopt)
Callback as used by getOperation.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
ListOperationsCallback(error, responseopt)
Callback as used by listOperations.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.ListOperationsResponse |
<optional> |
ListOperationsResponse |
WaitOperationCallback(error, responseopt)
Callback as used by waitOperation.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |