Class MetricsV1Beta3.MetricsV1Beta3Client

public class MetricsV1Beta3Client : ClientBase<MetricsV1Beta3.MetricsV1Beta3Client>

Client for MetricsV1Beta3

Inheritance

Object > ClientBase > ClientBase<MetricsV1Beta3.MetricsV1Beta3Client> > MetricsV1Beta3.MetricsV1Beta3Client

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

MetricsV1Beta3Client()

protected MetricsV1Beta3Client()

Protected parameterless constructor to allow creation of test doubles.

MetricsV1Beta3Client(CallInvoker)

public MetricsV1Beta3Client(CallInvoker callInvoker)

Creates a new client for MetricsV1Beta3 that uses a custom CallInvoker.

Parameter
TypeNameDescription
CallInvokercallInvoker

The callInvoker to use to make remote calls.

MetricsV1Beta3Client(ChannelBase)

public MetricsV1Beta3Client(ChannelBase channel)

Creates a new client for MetricsV1Beta3

Parameter
TypeNameDescription
ChannelBasechannel

The channel to use to make remote calls.

MetricsV1Beta3Client(ClientBase.ClientBaseConfiguration)

protected MetricsV1Beta3Client(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration

The client configuration.

Methods

GetJobExecutionDetails(GetJobExecutionDetailsRequest, CallOptions)

public virtual JobExecutionDetails GetJobExecutionDetails(GetJobExecutionDetailsRequest request, CallOptions options)

Request detailed information about the execution status of the job.

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

Parameters
TypeNameDescription
GetJobExecutionDetailsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
JobExecutionDetails

The response received from the server.

GetJobExecutionDetails(GetJobExecutionDetailsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual JobExecutionDetails GetJobExecutionDetails(GetJobExecutionDetailsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Request detailed information about the execution status of the job.

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

Parameters
TypeNameDescription
GetJobExecutionDetailsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
JobExecutionDetails

The response received from the server.

GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest, CallOptions)

public virtual AsyncUnaryCall<JobExecutionDetails> GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest request, CallOptions options)

Request detailed information about the execution status of the job.

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

Parameters
TypeNameDescription
GetJobExecutionDetailsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<JobExecutionDetails>

The call object.

GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<JobExecutionDetails> GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Request detailed information about the execution status of the job.

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

Parameters
TypeNameDescription
GetJobExecutionDetailsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<JobExecutionDetails>

The call object.

GetJobMetrics(GetJobMetricsRequest, CallOptions)

public virtual JobMetrics GetJobMetrics(GetJobMetricsRequest request, CallOptions options)

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
TypeNameDescription
GetJobMetricsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
JobMetrics

The response received from the server.

GetJobMetrics(GetJobMetricsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual JobMetrics GetJobMetrics(GetJobMetricsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
GetJobMetricsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
JobMetrics

The response received from the server.

GetJobMetricsAsync(GetJobMetricsRequest, CallOptions)

public virtual AsyncUnaryCall<JobMetrics> GetJobMetricsAsync(GetJobMetricsRequest request, CallOptions options)

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
TypeNameDescription
GetJobMetricsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<JobMetrics>

The call object.

GetJobMetricsAsync(GetJobMetricsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<JobMetrics> GetJobMetricsAsync(GetJobMetricsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
GetJobMetricsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<JobMetrics>

The call object.

GetStageExecutionDetails(GetStageExecutionDetailsRequest, CallOptions)

public virtual StageExecutionDetails GetStageExecutionDetails(GetStageExecutionDetailsRequest request, CallOptions options)

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
TypeNameDescription
GetStageExecutionDetailsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
StageExecutionDetails

The response received from the server.

GetStageExecutionDetails(GetStageExecutionDetailsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual StageExecutionDetails GetStageExecutionDetails(GetStageExecutionDetailsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
GetStageExecutionDetailsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
StageExecutionDetails

The response received from the server.

GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest, CallOptions)

public virtual AsyncUnaryCall<StageExecutionDetails> GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest request, CallOptions options)

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
TypeNameDescription
GetStageExecutionDetailsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<StageExecutionDetails>

The call object.

GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<StageExecutionDetails> GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
TypeNameDescription
GetStageExecutionDetailsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<StageExecutionDetails>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override MetricsV1Beta3.MetricsV1Beta3Client NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration
Returns
TypeDescription
MetricsV1Beta3.MetricsV1Beta3Client
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dataflow.V1Beta3.MetricsV1Beta3.MetricsV1Beta3Client>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)