Dataflow v1beta3 API - Class MessagesV1Beta3.MessagesV1Beta3Client (2.0.0-beta06)

public class MessagesV1Beta3.MessagesV1Beta3Client : ClientBase<MessagesV1Beta3.MessagesV1Beta3Client>

Reference documentation and code samples for the Dataflow v1beta3 API class MessagesV1Beta3.MessagesV1Beta3Client.

Client for MessagesV1Beta3

Inheritance

object > ClientBase > ClientBaseMessagesV1Beta3MessagesV1Beta3Client > MessagesV1Beta3.MessagesV1Beta3Client

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

MessagesV1Beta3Client()

protected MessagesV1Beta3Client()

Protected parameterless constructor to allow creation of test doubles.

MessagesV1Beta3Client(CallInvoker)

public MessagesV1Beta3Client(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

MessagesV1Beta3Client(ChannelBase)

public MessagesV1Beta3Client(ChannelBase channel)

Creates a new client for MessagesV1Beta3

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

MessagesV1Beta3Client(ClientBaseConfiguration)

protected MessagesV1Beta3Client(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

ListJobMessages(ListJobMessagesRequest, CallOptions)

public virtual ListJobMessagesResponse ListJobMessages(ListJobMessagesRequest request, CallOptions options)

Request the job status.

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

Parameters
Name Description
request ListJobMessagesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListJobMessagesResponse

The response received from the server.

ListJobMessages(ListJobMessagesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListJobMessagesResponse ListJobMessages(ListJobMessagesRequest 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.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

Parameters
Name Description
request ListJobMessagesRequest

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
ListJobMessagesResponse

The response received from the server.

ListJobMessagesAsync(ListJobMessagesRequest, CallOptions)

public virtual AsyncUnaryCall<ListJobMessagesResponse> ListJobMessagesAsync(ListJobMessagesRequest request, CallOptions options)

Request the job status.

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

Parameters
Name Description
request ListJobMessagesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListJobMessagesResponse

The call object.

ListJobMessagesAsync(ListJobMessagesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListJobMessagesResponse> ListJobMessagesAsync(ListJobMessagesRequest 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.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

Parameters
Name Description
request ListJobMessagesRequest

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
AsyncUnaryCallListJobMessagesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override MessagesV1Beta3.MessagesV1Beta3Client NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
MessagesV1Beta3MessagesV1Beta3Client
Overrides