Class v1beta3.MetricsV1Beta3Client

The Dataflow Metrics API lets you monitor the progress of Dataflow jobs. v1beta3

Package

@google-cloud/dataflow!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of MetricsV1Beta3Client.

Parameter
Type Name Description
ClientOptions opts

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

metricsV1Beta3Stub

metricsV1Beta3Stub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

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.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

getJobExecutionDetails(request, options)

getJobExecutionDetails(request?: protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IStageSummary[],
        protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest | null,
        protos.google.dataflow.v1beta3.IJobExecutionDetails
    ]>;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest request
CallOptions options
Returns
Type Description
Promise<[ protos.google.dataflow.v1beta3.IStageSummary[], protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest | null, protos.google.dataflow.v1beta3.IJobExecutionDetails ]>

getJobExecutionDetails(request, options, callback)

getJobExecutionDetails(request: protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, options: CallOptions, callback: PaginationCallback<protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, protos.google.dataflow.v1beta3.IJobExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IStageSummary>): void;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest request
CallOptions options
PaginationCallback<protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, protos.google.dataflow.v1beta3.IJobExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IStageSummary> callback
Returns
Type Description
void

getJobExecutionDetails(request, callback)

getJobExecutionDetails(request: protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, callback: PaginationCallback<protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, protos.google.dataflow.v1beta3.IJobExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IStageSummary>): void;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest request
PaginationCallback<protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, protos.google.dataflow.v1beta3.IJobExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IStageSummary> callback
Returns
Type Description
void

getJobExecutionDetailsAsync(request, options)

getJobExecutionDetailsAsync(request?: protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, options?: CallOptions): AsyncIterable<protos.google.dataflow.v1beta3.IStageSummary>;

Equivalent to getJobExecutionDetails, but returns an iterable object.

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

Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.dataflow.v1beta3.IStageSummary>

{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 [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

getJobExecutionDetailsStream(request, options)

getJobExecutionDetailsStream(request?: protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, options?: CallOptions): Transform;

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

Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobExecutionDetailsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{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 getJobExecutionDetailsAsync() 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.

getJobMetrics(request, options)

getJobMetrics(request?: protos.google.dataflow.v1beta3.IGetJobMetricsRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IJobMetrics,
        protos.google.dataflow.v1beta3.IGetJobMetricsRequest | undefined,
        {} | undefined
    ]>;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobMetricsRequest request
CallOptions options
Returns
Type Description
Promise<[ protos.google.dataflow.v1beta3.IJobMetrics, protos.google.dataflow.v1beta3.IGetJobMetricsRequest | undefined, {} | undefined ]>

getJobMetrics(request, options, callback)

getJobMetrics(request: protos.google.dataflow.v1beta3.IGetJobMetricsRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IJobMetrics, protos.google.dataflow.v1beta3.IGetJobMetricsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobMetricsRequest request
CallOptions options
Callback<protos.google.dataflow.v1beta3.IJobMetrics, protos.google.dataflow.v1beta3.IGetJobMetricsRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getJobMetrics(request, callback)

getJobMetrics(request: protos.google.dataflow.v1beta3.IGetJobMetricsRequest, callback: Callback<protos.google.dataflow.v1beta3.IJobMetrics, protos.google.dataflow.v1beta3.IGetJobMetricsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetJobMetricsRequest request
Callback<protos.google.dataflow.v1beta3.IJobMetrics, protos.google.dataflow.v1beta3.IGetJobMetricsRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Type Name Description
Callback<string, undefined, undefined> callback
Returns
Type Description
void

getStageExecutionDetails(request, options)

getStageExecutionDetails(request?: protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IWorkerDetails[],
        protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest | null,
        protos.google.dataflow.v1beta3.IStageExecutionDetails
    ]>;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest request
CallOptions options
Returns
Type Description
Promise<[ protos.google.dataflow.v1beta3.IWorkerDetails[], protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest | null, protos.google.dataflow.v1beta3.IStageExecutionDetails ]>

getStageExecutionDetails(request, options, callback)

getStageExecutionDetails(request: protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, options: CallOptions, callback: PaginationCallback<protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, protos.google.dataflow.v1beta3.IStageExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IWorkerDetails>): void;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest request
CallOptions options
PaginationCallback<protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, protos.google.dataflow.v1beta3.IStageExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IWorkerDetails> callback
Returns
Type Description
void

getStageExecutionDetails(request, callback)

getStageExecutionDetails(request: protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, callback: PaginationCallback<protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, protos.google.dataflow.v1beta3.IStageExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IWorkerDetails>): void;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest request
PaginationCallback<protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, protos.google.dataflow.v1beta3.IStageExecutionDetails | null | undefined, protos.google.dataflow.v1beta3.IWorkerDetails> callback
Returns
Type Description
void

getStageExecutionDetailsAsync(request, options)

getStageExecutionDetailsAsync(request?: protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, options?: CallOptions): AsyncIterable<protos.google.dataflow.v1beta3.IWorkerDetails>;

Equivalent to getStageExecutionDetails, but returns an iterable object.

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

Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.dataflow.v1beta3.IWorkerDetails>

{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 [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

getStageExecutionDetailsStream(request, options)

getStageExecutionDetailsStream(request?: protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest, options?: CallOptions): Transform;

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

Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetStageExecutionDetailsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{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 getStageExecutionDetailsAsync() 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.

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.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.