Google Cloud Dataproc v1 API - Class BatchControllerClientImpl (5.3.0) 

public sealed class BatchControllerClientImpl : BatchControllerClient

Reference documentation and code samples for the Google Cloud Dataproc v1 API class BatchControllerClientImpl.

BatchController client wrapper implementation, for convenient use.

Inheritance

Object > BatchControllerClient > BatchControllerClientImpl

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Remarks

The BatchController provides methods to manage batch workloads.

Constructors

BatchControllerClientImpl(BatchController.BatchControllerClient, BatchControllerSettings, ILogger)

public BatchControllerClientImpl(BatchController.BatchControllerClient grpcClient, BatchControllerSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientBatchController.BatchControllerClient

The underlying gRPC client.

settingsBatchControllerSettings

The base BatchControllerSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateBatchOperationsClient

public override OperationsClient CreateBatchOperationsClient { get; }

The long-running operations client for CreateBatch.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override BatchController.BatchControllerClient GrpcClient { get; }

The underlying gRPC BatchController client

Property Value
TypeDescription
BatchController.BatchControllerClient
Overrides

Methods

CreateBatch(CreateBatchRequest, CallSettings)

public override Operation<Batch, BatchOperationMetadata> CreateBatch(CreateBatchRequest request, CallSettings callSettings = null)

Creates a batch workload that executes asynchronously.

Parameters
NameDescription
requestCreateBatchRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Batch, BatchOperationMetadata>

The RPC response.

Overrides

CreateBatchAsync(CreateBatchRequest, CallSettings)

public override async Task<Operation<Batch, BatchOperationMetadata>> CreateBatchAsync(CreateBatchRequest request, CallSettings callSettings = null)

Creates a batch workload that executes asynchronously.

Parameters
NameDescription
requestCreateBatchRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Batch, BatchOperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteBatch(DeleteBatchRequest, CallSettings)

public override void DeleteBatch(DeleteBatchRequest request, CallSettings callSettings = null)

Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.

Parameters
NameDescription
requestDeleteBatchRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteBatchAsync(DeleteBatchRequest, CallSettings)

public override Task DeleteBatchAsync(DeleteBatchRequest request, CallSettings callSettings = null)

Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.

Parameters
NameDescription
requestDeleteBatchRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetBatch(GetBatchRequest, CallSettings)

public override Batch GetBatch(GetBatchRequest request, CallSettings callSettings = null)

Gets the batch workload resource representation.

Parameters
NameDescription
requestGetBatchRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Batch

The RPC response.

Overrides

GetBatchAsync(GetBatchRequest, CallSettings)

public override Task<Batch> GetBatchAsync(GetBatchRequest request, CallSettings callSettings = null)

Gets the batch workload resource representation.

Parameters
NameDescription
requestGetBatchRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Batch>

A Task containing the RPC response.

Overrides

ListBatches(ListBatchesRequest, CallSettings)

public override PagedEnumerable<ListBatchesResponse, Batch> ListBatches(ListBatchesRequest request, CallSettings callSettings = null)

Lists batch workloads.

Parameters
NameDescription
requestListBatchesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListBatchesResponse, Batch>

A pageable sequence of Batch resources.

Overrides

ListBatchesAsync(ListBatchesRequest, CallSettings)

public override PagedAsyncEnumerable<ListBatchesResponse, Batch> ListBatchesAsync(ListBatchesRequest request, CallSettings callSettings = null)

Lists batch workloads.

Parameters
NameDescription
requestListBatchesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListBatchesResponse, Batch>

A pageable asynchronous sequence of Batch resources.

Overrides