public sealed class MetricsV1Beta3ClientImpl : MetricsV1Beta3ClientReference documentation and code samples for the Dataflow v1beta3 API class MetricsV1Beta3ClientImpl.
MetricsV1Beta3 client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Dataflow.V1Beta3Assembly
Google.Cloud.Dataflow.V1Beta3.dll
Remarks
The Dataflow Metrics API lets you monitor the progress of Dataflow jobs.
Constructors
MetricsV1Beta3ClientImpl(MetricsV1Beta3Client, MetricsV1Beta3Settings, ILogger)
public MetricsV1Beta3ClientImpl(MetricsV1Beta3.MetricsV1Beta3Client grpcClient, MetricsV1Beta3Settings settings, ILogger logger)Constructs a client wrapper for the MetricsV1Beta3 service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | MetricsV1Beta3MetricsV1Beta3ClientThe underlying gRPC client. |
settings | MetricsV1Beta3SettingsThe base MetricsV1Beta3Settings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override MetricsV1Beta3.MetricsV1Beta3Client GrpcClient { get; }The underlying gRPC MetricsV1Beta3 client
| Property Value | |
|---|---|
| Type | Description |
MetricsV1Beta3MetricsV1Beta3Client | |
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 | GetJobExecutionDetailsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableJobExecutionDetailsStageSummary | A pageable sequence of StageSummary resources. |
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 | GetJobExecutionDetailsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableJobExecutionDetailsStageSummary | A pageable asynchronous sequence of StageSummary resources. |
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 | GetJobMetricsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
JobMetrics | The RPC response. |
GetJobMetricsAsync(GetJobMetricsRequest, CallSettings)
public override Task<JobMetrics> GetJobMetricsAsync(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 | GetJobMetricsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskJobMetrics | A Task containing the RPC response. |
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 | GetStageExecutionDetailsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableStageExecutionDetailsWorkerDetails | A pageable sequence of WorkerDetails resources. |
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 | GetStageExecutionDetailsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableStageExecutionDetailsWorkerDetails | A pageable asynchronous sequence of WorkerDetails resources. |