Class MetricsV1Beta3ClientImpl (1.0.0-beta03)

public sealed class MetricsV1Beta3ClientImpl : MetricsV1Beta3Client

MetricsV1Beta3 client wrapper implementation, for convenient use.

Inheritance

Object > MetricsV1Beta3Client > MetricsV1Beta3ClientImpl

Inherited Members

MetricsV1Beta3Client.DefaultEndpoint

MetricsV1Beta3Client.DefaultScopes

MetricsV1Beta3Client.CreateAsync(CancellationToken)

MetricsV1Beta3Client.Create()

MetricsV1Beta3Client.ShutdownDefaultChannelsAsync()

MetricsV1Beta3Client.GetJobMetricsAsync(GetJobMetricsRequest, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Remarks

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

Constructors

MetricsV1Beta3ClientImpl(MetricsV1Beta3.MetricsV1Beta3Client, MetricsV1Beta3Settings)

public MetricsV1Beta3ClientImpl(MetricsV1Beta3.MetricsV1Beta3Client grpcClient, MetricsV1Beta3Settings settings)

Constructs a client wrapper for the MetricsV1Beta3 service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`MetricsV1Beta3.MetricsV1Beta3Client` The underlying gRPC client.
`settings`	`MetricsV1Beta3Settings` The base MetricsV1Beta3Settings used within this client.

Properties

GrpcClient

public override MetricsV1Beta3.MetricsV1Beta3Client GrpcClient { get; }

The underlying gRPC MetricsV1Beta3 client

Property Value
Type	Description
`MetricsV1Beta3.MetricsV1Beta3Client`

Overrides

MetricsV1Beta3Client.GrpcClient

Methods

GetJobExecutionDetails(GetJobExecutionDetailsRequest, CallSettings)

public override PagedEnumerable<JobExecutionDetails, StageSummary> GetJobExecutionDetails(GetJobExecutionDetailsRequest request, CallSettings callSettings = null)

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Parameters
Name	Description
`request`	`GetJobExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<JobExecutionDetails, StageSummary>`	A pageable sequence of StageSummary resources.

Overrides

MetricsV1Beta3Client.GetJobExecutionDetails(GetJobExecutionDetailsRequest, CallSettings)

GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest, CallSettings)

public override PagedAsyncEnumerable<JobExecutionDetails, StageSummary> GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest request, CallSettings callSettings = null)

Request detailed information about the execution status of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Parameters
Name	Description
`request`	`GetJobExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<JobExecutionDetails, StageSummary>`	A pageable asynchronous sequence of StageSummary resources.

Overrides

MetricsV1Beta3Client.GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest, CallSettings)

GetJobMetrics(GetJobMetricsRequest, CallSettings)

public override JobMetrics GetJobMetrics(GetJobMetricsRequest request, CallSettings callSettings = null)

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

Parameters
Name	Description
`request`	`GetJobMetricsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`JobMetrics`	The RPC response.

Overrides

MetricsV1Beta3Client.GetJobMetrics(GetJobMetricsRequest, CallSettings)

GetJobMetricsAsync(GetJobMetricsRequest, CallSettings)

public override Task<JobMetrics> GetJobMetricsAsync(GetJobMetricsRequest request, CallSettings callSettings = null)

Request the job status.

Parameters
Name	Description
`request`	`GetJobMetricsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<JobMetrics>`	A Task containing the RPC response.

Overrides

MetricsV1Beta3Client.GetJobMetricsAsync(GetJobMetricsRequest, CallSettings)

GetStageExecutionDetails(GetStageExecutionDetailsRequest, CallSettings)

public override PagedEnumerable<StageExecutionDetails, WorkerDetails> GetStageExecutionDetails(GetStageExecutionDetailsRequest request, CallSettings callSettings = null)

Request detailed information about the execution status of a stage of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Parameters
Name	Description
`request`	`GetStageExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<StageExecutionDetails, WorkerDetails>`	A pageable sequence of WorkerDetails resources.

Overrides

MetricsV1Beta3Client.GetStageExecutionDetails(GetStageExecutionDetailsRequest, CallSettings)

GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest, CallSettings)

public override PagedAsyncEnumerable<StageExecutionDetails, WorkerDetails> GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest request, CallSettings callSettings = null)

Request detailed information about the execution status of a stage of the job.

EXPERIMENTAL. This API is subject to change or removal without notice.

Parameters
Name	Description
`request`	`GetStageExecutionDetailsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<StageExecutionDetails, WorkerDetails>`	A pageable asynchronous sequence of WorkerDetails resources.

Overrides

MetricsV1Beta3Client.GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest, CallSettings)