ExecutionsClient

ExecutionsClient

Executions is used to start and manage running instances of Workflows called executions.

Constructor

new ExecutionsClient(optionsopt, gaxInstanceopt)

Construct an instance of ExecutionsClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean | "rest" <optional>

Use HTTP fallback mode. Pass "rest" to use HTTP/1.1 REST API instead of gRPC. For more information, please check the documentation.

gaxInstance gax <optional>

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);

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

executionPath(project, location, workflow, execution) → {string}

Return a fully-qualified execution resource name string.

Parameters:
Name Type Description
project string
location string
workflow string
execution string
Returns:
Type Description
string

Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listExecutionsAsync(request, optionsopt) → {Object}

Equivalent to listExecutions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

pageSize number

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.

pageToken string

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.

view google.cloud.workflows.executions.v1.ExecutionView <optional>

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Execution. 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 for more details and examples.

Example
  /**
   * 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, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

pageSize number

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.

pageToken string

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.

view google.cloud.workflows.executions.v1.ExecutionView <optional>

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing Execution 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 for more details and examples.

matchExecutionFromExecutionName(executionName) → {string}

Parse the execution from Execution resource.

Parameters:
Name Type Description
executionName string

A fully-qualified path representing Execution resource.

Returns:
Type Description
string

A string representing the execution.

matchLocationFromExecutionName(executionName) → {string}

Parse the location from Execution resource.

Parameters:
Name Type Description
executionName string

A fully-qualified path representing Execution resource.

Returns:
Type Description
string

A string representing the location.

matchLocationFromWorkflowName(workflowName) → {string}

Parse the location from Workflow resource.

Parameters:
Name Type Description
workflowName string

A fully-qualified path representing Workflow resource.

Returns:
Type Description
string

A string representing the location.

matchProjectFromExecutionName(executionName) → {string}

Parse the project from Execution resource.

Parameters:
Name Type Description
executionName string

A fully-qualified path representing Execution resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromWorkflowName(workflowName) → {string}

Parse the project from Workflow resource.

Parameters:
Name Type Description
workflowName string

A fully-qualified path representing Workflow resource.

Returns:
Type Description
string

A string representing the project.

matchWorkflowFromExecutionName(executionName) → {string}

Parse the workflow from Execution resource.

Parameters:
Name Type Description
executionName string

A fully-qualified path representing Execution resource.

Returns:
Type Description
string

A string representing the workflow.

matchWorkflowFromWorkflowName(workflowName) → {string}

Parse the workflow from Workflow resource.

Parameters:
Name Type Description
workflowName string

A fully-qualified path representing Workflow resource.

Returns:
Type Description
string

A string representing the workflow.

workflowPath(project, location, workflow) → {string}

Return a fully-qualified workflow resource name string.

Parameters:
Name Type Description
project string
location string
workflow string
Returns:
Type Description
string

Resource name string.