Constructor
new Executions(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new Executions 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
cancelExecution(request, callback) → {undefined}
Calls CancelExecution.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.ICancelExecutionRequest |
CancelExecutionRequest message or plain object |
callback |
google.cloud.workflows.executions.v1.Executions.CancelExecutionCallback |
Node-style callback called with the error, if any, and Execution |
Returns:
| Type | Description |
|---|---|
| undefined |
cancelExecution(request) → {Promise.<google.cloud.workflows.executions.v1.Execution>}
Calls CancelExecution.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.ICancelExecutionRequest |
CancelExecutionRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.workflows.executions.v1.Execution> |
Promise |
createExecution(request, callback) → {undefined}
Calls CreateExecution.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.ICreateExecutionRequest |
CreateExecutionRequest message or plain object |
callback |
google.cloud.workflows.executions.v1.Executions.CreateExecutionCallback |
Node-style callback called with the error, if any, and Execution |
Returns:
| Type | Description |
|---|---|
| undefined |
createExecution(request) → {Promise.<google.cloud.workflows.executions.v1.Execution>}
Calls CreateExecution.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.ICreateExecutionRequest |
CreateExecutionRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.workflows.executions.v1.Execution> |
Promise |
getExecution(request, callback) → {undefined}
Calls GetExecution.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.IGetExecutionRequest |
GetExecutionRequest message or plain object |
callback |
google.cloud.workflows.executions.v1.Executions.GetExecutionCallback |
Node-style callback called with the error, if any, and Execution |
Returns:
| Type | Description |
|---|---|
| undefined |
getExecution(request) → {Promise.<google.cloud.workflows.executions.v1.Execution>}
Calls GetExecution.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.IGetExecutionRequest |
GetExecutionRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.workflows.executions.v1.Execution> |
Promise |
listExecutions(request, callback) → {undefined}
Calls ListExecutions.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.IListExecutionsRequest |
ListExecutionsRequest message or plain object |
callback |
google.cloud.workflows.executions.v1.Executions.ListExecutionsCallback |
Node-style callback called with the error, if any, and ListExecutionsResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
listExecutions(request) → {Promise.<google.cloud.workflows.executions.v1.ListExecutionsResponse>}
Calls ListExecutions.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.workflows.executions.v1.IListExecutionsRequest |
ListExecutionsRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.workflows.executions.v1.ListExecutionsResponse> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Executions}
Creates new Executions 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 |
|---|---|
| Executions |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
CancelExecutionCallback(error, responseopt)
Callback as used by cancelExecution.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.workflows.executions.v1.Execution |
<optional> |
Execution |
CreateExecutionCallback(error, responseopt)
Callback as used by createExecution.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.workflows.executions.v1.Execution |
<optional> |
Execution |
GetExecutionCallback(error, responseopt)
Callback as used by getExecution.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.workflows.executions.v1.Execution |
<optional> |
Execution |
ListExecutionsCallback(error, responseopt)
Callback as used by listExecutions.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.workflows.executions.v1.ListExecutionsResponse |
<optional> |
ListExecutionsResponse |