Dataflow v1beta3 API - Class MetricsV1Beta3.MetricsV1Beta3Client (2.0.0-beta06)

Version 2.0.0-beta06

• 2.0.0-beta07 (latest)
• 2.0.0-beta06
• 1.0.0-beta03

public class MetricsV1Beta3.MetricsV1Beta3Client : ClientBase<MetricsV1Beta3.MetricsV1Beta3Client>

Reference documentation and code samples for the Dataflow v1beta3 API class MetricsV1Beta3.MetricsV1Beta3Client.

Client for MetricsV1Beta3

Inheritance

object > ClientBase > ClientBaseMetricsV1Beta3MetricsV1Beta3Client > MetricsV1Beta3.MetricsV1Beta3Client

Inherited Members

ClientBase<MetricsV1Beta3.MetricsV1Beta3Client>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

MetricsV1Beta3Client(ChannelBase)

public MetricsV1Beta3Client(ChannelBase channel)

Creates a new client for MetricsV1Beta3

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

MetricsV1Beta3Client(ClientBaseConfiguration)

protected MetricsV1Beta3Client(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration 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
Name	Description
request	GetJobExecutionDetailsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
JobExecutionDetails	The response received from the server.

GetJobExecutionDetails(GetJobExecutionDetailsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	GetJobExecutionDetailsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallJobExecutionDetails	The call object.

GetJobExecutionDetailsAsync(GetJobExecutionDetailsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallJobExecutionDetails	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
Name	Description
request	GetJobMetricsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
JobMetrics	The response received from the server.

GetJobMetrics(GetJobMetricsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	GetJobMetricsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallJobMetrics	The call object.

GetJobMetricsAsync(GetJobMetricsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallJobMetrics	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
Name	Description
request	GetStageExecutionDetailsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
StageExecutionDetails	The response received from the server.

GetStageExecutionDetails(GetStageExecutionDetailsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
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
Name	Description
request	GetStageExecutionDetailsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallStageExecutionDetails	The call object.

GetStageExecutionDetailsAsync(GetStageExecutionDetailsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallStageExecutionDetails	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
MetricsV1Beta3MetricsV1Beta3Client

Overrides

ClientBase<MetricsV1Beta3.MetricsV1Beta3Client>.NewInstance(ClientBase.ClientBaseConfiguration)