Constructor
new MetricsV1Beta3Client(optionsopt, gaxInstanceopt)
Construct an instance of MetricsV1Beta3Client.
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
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
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. |
getJobExecutionDetailsAsync(request, optionsopt) → {Object}
Equivalent to getJobExecutionDetails, 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
|
|||||||||||||||||||
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 StageSummary. 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 execution details for.
*/
// const jobId = 'abc123'
/**
* The regional endpoint
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
* contains the job specified by job_id.
*/
// const location = 'abc123'
/**
* If specified, determines the maximum number of stages 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'
// Imports the Dataflow library
const {MetricsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;
// Instantiates a client
const dataflowClient = new MetricsV1Beta3Client();
async function callGetJobExecutionDetails() {
// Construct request
const request = {
};
// Run request
const iterable = await dataflowClient.getJobExecutionDetailsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callGetJobExecutionDetails();
getJobExecutionDetailsStream(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
|
|||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Stream |
An object stream which emits an object representing StageSummary 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 |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
| Type | Description |
|---|---|
| Promise |
A promise that resolves to string containing the project ID. |
getStageExecutionDetailsAsync(request, optionsopt) → {Object}
Equivalent to getStageExecutionDetails, 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
|
||||||||||||||||||||||||||||
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 WorkerDetails. 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 execution details for.
*/
// const jobId = 'abc123'
/**
* The regional endpoint
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
* contains the job specified by job_id.
*/
// const location = 'abc123'
/**
* The stage for which to fetch information.
*/
// const stageId = 'abc123'
/**
* If specified, determines the maximum number of work items 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'
/**
* Lower time bound of work items to include, by start time.
*/
// const startTime = {}
/**
* Upper time bound of work items to include, by start time.
*/
// const endTime = {}
// Imports the Dataflow library
const {MetricsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;
// Instantiates a client
const dataflowClient = new MetricsV1Beta3Client();
async function callGetStageExecutionDetails() {
// Construct request
const request = {
};
// Run request
const iterable = await dataflowClient.getStageExecutionDetailsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callGetStageExecutionDetails();
getStageExecutionDetailsStream(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
|
||||||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Stream |
An object stream which emits an object representing WorkerDetails 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 |
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. |