MessagesV1Beta3Client

MessagesV1Beta3Client

The Dataflow Messages API is used for monitoring the progress of Dataflow jobs.

Constructor

new MessagesV1Beta3Client(optionsopt, gaxInstanceopt)

Construct an instance of MessagesV1Beta3Client.

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 MessagesV1Beta3Client({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.

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.

listJobMessagesAsync(request, optionsopt) → {Object}

Equivalent to listJobMessages, 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
projectId string

A project id.

jobId string

The job to get messages about.

minimumImportance google.dataflow.v1beta3.JobMessageImportance

Filter to only get messages with importance >= level

pageSize number

If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

pageToken string

If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

startTime google.protobuf.Timestamp

If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

endTime google.protobuf.Timestamp

Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

location string

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

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 JobMessage. 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.
   */
  /**
   *  A project id.
   */
  // const projectId = 'abc123'
  /**
   *  The job to get messages about.
   */
  // const jobId = 'abc123'
  /**
   *  Filter to only get messages with importance >= level
   */
  // const minimumImportance = {}
  /**
   *  If specified, determines the maximum number of messages to
   *  return.  If unspecified, the service may choose an appropriate
   *  default, or may return an arbitrarily large number of results.
   */
  // const pageSize = 1234
  /**
   *  If supplied, this should be the value of next_page_token returned
   *  by an earlier call. This will cause the next page of results to
   *  be returned.
   */
  // const pageToken = 'abc123'
  /**
   *  If specified, return only messages with timestamps >= start_time.
   *  The default is the job creation time (i.e. beginning of messages).
   */
  // const startTime = {}
  /**
   *  Return only messages with timestamps < end_time. The default is now
   *  (i.e. return up to the latest messages available).
   */
  // const endTime = {}
  /**
   *  The regional endpoint 
   *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
   *  contains the job specified by job_id.
   */
  // const location = 'abc123'

  // Imports the Dataflow library
  const {MessagesV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new MessagesV1Beta3Client();

  async function callListJobMessages() {
    // Construct request
    const request = {
    };

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

  callListJobMessages();

listJobMessagesStream(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
projectId string

A project id.

jobId string

The job to get messages about.

minimumImportance google.dataflow.v1beta3.JobMessageImportance

Filter to only get messages with importance >= level

pageSize number

If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

pageToken string

If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

startTime google.protobuf.Timestamp

If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

endTime google.protobuf.Timestamp

Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

location string

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

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