TasksClient

TasksClient

Cloud Run Task Control Plane API.

Constructor

new TasksClient(optionsopt, gaxInstanceopt)

Construct an instance of TasksClient.

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 <optional>

Use HTTP/1.1 REST mode. 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 TasksClient({fallback: true}, 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.

cryptoKeyPath(project, location, key_ring, crypto_key) → {string}

Return a fully-qualified cryptoKey resource name string.

Parameters:
Name Type Description
project string
location string
key_ring string
crypto_key string
Returns:
Type Description
string

Resource name string.

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

Return a fully-qualified execution resource name string.

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

Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

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.

jobPath(project, location, job) → {string}

Return a fully-qualified job resource name string.

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

Resource name string.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. 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 Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
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 Location. 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
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listTasksAsync(request, optionsopt) → {Object}

Equivalent to listTasks, 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 Description
parent string

Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
pageSize number

Maximum number of Tasks to return in this call.
pageToken string

A page token received from a previous call to ListTasks. All other parameters must match.
showDeleted boolean

If true, returns deleted (but unexpired) resources along with active ones.
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 Task. 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. The Execution from which the Tasks should be listed.
   *  To list all Tasks across Executions of a Job, use "-" instead of Execution
   *  name. To list all Tasks across Jobs, use "-" instead of Job name. Format:
   *  projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of Tasks to return in this call.
   */
  // const pageSize = 1234
  /**
   *  A page token received from a previous call to ListTasks.
   *  All other parameters must match.
   */
  // const pageToken = 'abc123'
  /**
   *  If true, returns deleted (but unexpired) resources along with active ones.
   */
  // const showDeleted = true

  // Imports the Run library
  const {TasksClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new TasksClient();

  async function callListTasks() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await runClient.listTasksAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTasks();

listTasksStream(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 Description
parent string

Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
pageSize number

Maximum number of Tasks to return in this call.
pageToken string

A page token received from a previous call to ListTasks. All other parameters must match.
showDeleted boolean

If true, returns deleted (but unexpired) resources along with active ones.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Task 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 listTasksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

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

Resource name string.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName) → {string}

Parse the crypto_key from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the crypto_key.

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.

matchExecutionFromTaskName(taskName) → {string}

Parse the execution from Task resource.

Parameters:
Name Type Description
taskName string

A fully-qualified path representing Task resource.
Returns:
Type Description
string

A string representing the execution.

matchJobFromExecutionName(executionName) → {string}

Parse the job from Execution resource.

Parameters:
Name Type Description
executionName string

A fully-qualified path representing Execution resource.
Returns:
Type Description
string

A string representing the job.

matchJobFromJobName(jobName) → {string}

Parse the job from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.
Returns:
Type Description
string

A string representing the job.

matchJobFromTaskName(taskName) → {string}

Parse the job from Task resource.

Parameters:
Name Type Description
taskName string

A fully-qualified path representing Task resource.
Returns:
Type Description
string

A string representing the job.

matchKeyRingFromCryptoKeyName(cryptoKeyName) → {string}

Parse the key_ring from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the key_ring.

matchLocationFromCryptoKeyName(cryptoKeyName) → {string}

Parse the location from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the location.

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.

matchLocationFromJobName(jobName) → {string}

Parse the location from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromRevisionName(revisionName) → {string}

Parse the location from Revision resource.

Parameters:
Name Type Description
revisionName string

A fully-qualified path representing Revision resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromServiceName(serviceName) → {string}

Parse the location from Service resource.

Parameters:
Name Type Description
serviceName string

A fully-qualified path representing Service resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTaskName(taskName) → {string}

Parse the location from Task resource.

Parameters:
Name Type Description
taskName string

A fully-qualified path representing Task resource.
Returns:
Type Description
string

A string representing the location.

matchProjectFromCryptoKeyName(cryptoKeyName) → {string}

Parse the project from CryptoKey resource.

Parameters:
Name Type Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.
Returns:
Type Description
string

A string representing the project.

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.

matchProjectFromJobName(jobName) → {string}

Parse the project from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromRevisionName(revisionName) → {string}

Parse the project from Revision resource.

Parameters:
Name Type Description
revisionName string

A fully-qualified path representing Revision resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromServiceName(serviceName) → {string}

Parse the project from Service resource.

Parameters:
Name Type Description
serviceName string

A fully-qualified path representing Service resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTaskName(taskName) → {string}

Parse the project from Task resource.

Parameters:
Name Type Description
taskName string

A fully-qualified path representing Task resource.
Returns:
Type Description
string

A string representing the project.

matchRevisionFromRevisionName(revisionName) → {string}

Parse the revision from Revision resource.

Parameters:
Name Type Description
revisionName string

A fully-qualified path representing Revision resource.
Returns:
Type Description
string

A string representing the revision.

matchServiceFromRevisionName(revisionName) → {string}

Parse the service from Revision resource.

Parameters:
Name Type Description
revisionName string

A fully-qualified path representing Revision resource.
Returns:
Type Description
string

A string representing the service.

matchServiceFromServiceName(serviceName) → {string}

Parse the service from Service resource.

Parameters:
Name Type Description
serviceName string

A fully-qualified path representing Service resource.
Returns:
Type Description
string

A string representing the service.

matchTaskFromTaskName(taskName) → {string}

Parse the task from Task resource.

Parameters:
Name Type Description
taskName string

A fully-qualified path representing Task resource.
Returns:
Type Description
string

A string representing the task.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

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

Resource name string.

revisionPath(project, location, service, revision) → {string}

Return a fully-qualified revision resource name string.

Parameters:
Name Type Description
project string
location string
service string
revision string
Returns:
Type Description
string

Resource name string.

servicePath(project, location, service) → {string}

Return a fully-qualified service resource name string.

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

Resource name string.

taskPath(project, location, job, execution, task) → {string}

Return a fully-qualified task resource name string.

Parameters:
Name Type Description
project string
location string
job string
execution string
task string
Returns:
Type Description
string

Resource name string.