Executions is used to start and manage running instances of called executions. v1
Package
@google-cloud/workflowsConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of ExecutionsClient.
opts
ClientOptions
gaxInstance
typeof gax | typeof gax.fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ExecutionsClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
executionsStub
executionsStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
cancelExecution(request, options)
cancelExecution
(
request
?:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICancelExecutionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
(
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICancelExecutionRequest
|
undefined
),
{}
|
undefined
]>;
Cancels an execution of the given name.
request
protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.workflows.executions.v1.IExecution
,
(protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the execution to be cancelled.
* Format:
* projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
*/
// const name = 'abc123'
// Imports the Executions library
const
{
ExecutionsClient
}
=
require
(
'@google-cloud/workflow-executions'
).
v1
;
// Instantiates a client
const
executionsClient
=
new
ExecutionsClient
();
async
function
callCancelExecution
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
executionsClient
.
cancelExecution
(
request
);
console
.
log
(
response
);
}
callCancelExecution
();
cancelExecution(request, options, callback)
cancelExecution
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICancelExecutionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICancelExecutionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
options
CallOptions
callback
Callback
<protos. google.cloud.workflows.executions.v1.IExecution
, protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
| null | undefined, {} | null | undefined>
void
cancelExecution(request, callback)
cancelExecution
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICancelExecutionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICancelExecutionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
callback
Callback
<protos. google.cloud.workflows.executions.v1.IExecution
, protos. google.cloud.workflows.executions.v1.ICancelExecutionRequest
| null | undefined, {} | null | undefined>
void
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createExecution(request, options)
createExecution
(
request
?:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICreateExecutionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
(
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICreateExecutionRequest
|
undefined
),
{}
|
undefined
]>;
Creates a new execution using the latest revision of the given workflow.
request
protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.workflows.executions.v1.IExecution
,
(protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the workflow for which an execution should be created.
* Format: projects/{project}/locations/{location}/workflows/{workflow}
* The latest revision of the workflow will be used.
*/
// const parent = 'abc123'
/**
* Required. Execution to be created.
*/
// const execution = {}
// Imports the Executions library
const
{
ExecutionsClient
}
=
require
(
'@google-cloud/workflow-executions'
).
v1
;
// Instantiates a client
const
executionsClient
=
new
ExecutionsClient
();
async
function
callCreateExecution
()
{
// Construct request
const
request
=
{
parent
,
execution
,
};
// Run request
const
response
=
await
executionsClient
.
createExecution
(
request
);
console
.
log
(
response
);
}
callCreateExecution
();
createExecution(request, options, callback)
createExecution
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICreateExecutionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICreateExecutionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
options
CallOptions
callback
Callback
<protos. google.cloud.workflows.executions.v1.IExecution
, protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
| null | undefined, {} | null | undefined>
void
createExecution(request, callback)
createExecution
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICreateExecutionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
ICreateExecutionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
callback
Callback
<protos. google.cloud.workflows.executions.v1.IExecution
, protos. google.cloud.workflows.executions.v1.ICreateExecutionRequest
| null | undefined, {} | null | undefined>
void
executionPath(project, location, workflow, execution)
executionPath
(
project
:
string
,
location
:
string
,
workflow
:
string
,
execution
:
string
)
:
string
;
Return a fully-qualified execution resource name string.
project
string
location
string
workflow
string
execution
string
string
{string} Resource name string.
getExecution(request, options)
getExecution
(
request
?:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IGetExecutionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
(
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IGetExecutionRequest
|
undefined
),
{}
|
undefined
]>;
Returns an execution of the given name.
request
protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.workflows.executions.v1.IExecution
,
(protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the execution to be retrieved.
* Format:
* projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
*/
// const name = 'abc123'
/**
* Optional. A view defining which fields should be filled in the returned execution.
* The API will default to the FULL view.
*/
// const view = {}
// Imports the Executions library
const
{
ExecutionsClient
}
=
require
(
'@google-cloud/workflow-executions'
).
v1
;
// Instantiates a client
const
executionsClient
=
new
ExecutionsClient
();
async
function
callGetExecution
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
executionsClient
.
getExecution
(
request
);
console
.
log
(
response
);
}
callGetExecution
();
getExecution(request, options, callback)
getExecution
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IGetExecutionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IGetExecutionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
options
CallOptions
callback
Callback
<protos. google.cloud.workflows.executions.v1.IExecution
, protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
| null | undefined, {} | null | undefined>
void
getExecution(request, callback)
getExecution
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IGetExecutionRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IGetExecutionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
callback
Callback
<protos. google.cloud.workflows.executions.v1.IExecution
, protos. google.cloud.workflows.executions.v1.IGetExecutionRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listExecutions(request, options)
listExecutions
(
request
?:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
[],
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
|
null
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsResponse
]>;
Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
request
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.workflows.executions.v1.IExecution
[],
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
| null,
protos. google.cloud.workflows.executions.v1.IListExecutionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listExecutionsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listExecutions(request, options, callback)
listExecutions
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
, protos. google.cloud.workflows.executions.v1.IListExecutionsResponse
| null | undefined, protos. google.cloud.workflows.executions.v1.IExecution
>
void
listExecutions(request, callback)
listExecutions
(
request
:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
> )
:
void
;
request
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
callback
PaginationCallback
<protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
, protos. google.cloud.workflows.executions.v1.IListExecutionsResponse
| null | undefined, protos. google.cloud.workflows.executions.v1.IExecution
>
void
listExecutionsAsync(request, options)
listExecutionsAsync
(
request
?:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IExecution
> ;
Equivalent to listExecutions
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.workflows.executions.v1.IExecution
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the workflow for which the executions should be listed.
* Format: projects/{project}/locations/{location}/workflows/{workflow}
*/
// const parent = 'abc123'
/**
* Maximum number of executions to return per call.
* Max supported value depends on the selected Execution view: it's 10000 for
* BASIC and 100 for FULL. The default value used if the field is not
* specified is 100, regardless of the selected view. Values greater than
* the max value will be coerced down to it.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListExecutions` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListExecutions` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. A view defining which fields should be filled in the returned executions.
* The API will default to the BASIC view.
*/
// const view = {}
// Imports the Executions library
const
{
ExecutionsClient
}
=
require
(
'@google-cloud/workflow-executions'
).
v1
;
// Instantiates a client
const
executionsClient
=
new
ExecutionsClient
();
async
function
callListExecutions
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
executionsClient
.
listExecutionsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListExecutions
();
listExecutionsStream(request, options)
listExecutionsStream
(
request
?:
protos
.
google
.
cloud
.
workflows
.
executions
.
v1
.
IListExecutionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.workflows.executions.v1.IListExecutionsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listExecutionsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
matchExecutionFromExecutionName(executionName)
matchExecutionFromExecutionName
(
executionName
:
string
)
:
string
|
number
;
Parse the execution from Execution resource.
executionName
string
A fully-qualified path representing Execution resource.
string | number
{string} A string representing the execution.
matchLocationFromExecutionName(executionName)
matchLocationFromExecutionName
(
executionName
:
string
)
:
string
|
number
;
Parse the location from Execution resource.
executionName
string
A fully-qualified path representing Execution resource.
string | number
{string} A string representing the location.
matchLocationFromWorkflowName(workflowName)
matchLocationFromWorkflowName
(
workflowName
:
string
)
:
string
|
number
;
Parse the location from Workflow resource.
workflowName
string
A fully-qualified path representing Workflow resource.
string | number
{string} A string representing the location.
matchProjectFromExecutionName(executionName)
matchProjectFromExecutionName
(
executionName
:
string
)
:
string
|
number
;
Parse the project from Execution resource.
executionName
string
A fully-qualified path representing Execution resource.
string | number
{string} A string representing the project.
matchProjectFromWorkflowName(workflowName)
matchProjectFromWorkflowName
(
workflowName
:
string
)
:
string
|
number
;
Parse the project from Workflow resource.
workflowName
string
A fully-qualified path representing Workflow resource.
string | number
{string} A string representing the project.
matchWorkflowFromExecutionName(executionName)
matchWorkflowFromExecutionName
(
executionName
:
string
)
:
string
|
number
;
Parse the workflow from Execution resource.
executionName
string
A fully-qualified path representing Execution resource.
string | number
{string} A string representing the workflow.
matchWorkflowFromWorkflowName(workflowName)
matchWorkflowFromWorkflowName
(
workflowName
:
string
)
:
string
|
number
;
Parse the workflow from Workflow resource.
workflowName
string
A fully-qualified path representing Workflow resource.
string | number
{string} A string representing the workflow.
workflowPath(project, location, workflow)
workflowPath
(
project
:
string
,
location
:
string
,
workflow
:
string
)
:
string
;
Return a fully-qualified workflow resource name string.
project
string
location
string
workflow
string
string
{string} Resource name string.
