Dataflow v1beta3 API - Class MessagesV1Beta3ClientImpl (2.0.0-beta06)

public sealed class MessagesV1Beta3ClientImpl : MessagesV1Beta3Client

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

MessagesV1Beta3 client wrapper implementation, for convenient use.

Inheritance

object > MessagesV1Beta3Client > MessagesV1Beta3ClientImpl

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Remarks

The Dataflow Messages API is used for monitoring the progress of Dataflow jobs.

Constructors

MessagesV1Beta3ClientImpl(MessagesV1Beta3Client, MessagesV1Beta3Settings, ILogger)

public MessagesV1Beta3ClientImpl(MessagesV1Beta3.MessagesV1Beta3Client grpcClient, MessagesV1Beta3Settings settings, ILogger logger)

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

Parameters
Name Description
grpcClient MessagesV1Beta3MessagesV1Beta3Client

The underlying gRPC client.

settings MessagesV1Beta3Settings

The base MessagesV1Beta3Settings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override MessagesV1Beta3.MessagesV1Beta3Client GrpcClient { get; }

The underlying gRPC MessagesV1Beta3 client

Property Value
Type Description
MessagesV1Beta3MessagesV1Beta3Client
Overrides

Methods

ListJobMessages(ListJobMessagesRequest, CallSettings)

public override PagedEnumerable<ListJobMessagesResponse, JobMessage> ListJobMessages(ListJobMessagesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListJobMessagesResponseJobMessage

A pageable sequence of JobMessage resources.

Overrides

ListJobMessagesAsync(ListJobMessagesRequest, CallSettings)

public override PagedAsyncEnumerable<ListJobMessagesResponse, JobMessage> ListJobMessagesAsync(ListJobMessagesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListJobMessagesResponseJobMessage

A pageable asynchronous sequence of JobMessage resources.

Overrides