Class BatchControllerClientImpl (5.0.0)

Version 5.0.0

• 5.16.0 (latest)
• 5.15.0
• 5.14.0
• 5.13.0
• 5.12.0
• 5.11.0
• 5.10.0
• 5.9.0
• 5.8.0
• 5.7.0
• 5.6.0
• 5.5.0
• 5.4.0
• 5.3.0
• 5.2.0
• 5.1.0
• 5.0.0
• 4.0.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0

public sealed class BatchControllerClientImpl : BatchControllerClient

BatchController client wrapper implementation, for convenient use.

Inheritance

Object > BatchControllerClient > BatchControllerClientImpl

Inherited Members

BatchControllerClient.DefaultEndpoint

BatchControllerClient.DefaultScopes

BatchControllerClient.ServiceMetadata

BatchControllerClient.CreateAsync(CancellationToken)

BatchControllerClient.Create()

BatchControllerClient.ShutdownDefaultChannelsAsync()

BatchControllerClient.CreateBatchAsync(CreateBatchRequest, CancellationToken)

BatchControllerClient.PollOnceCreateBatch(String, CallSettings)

BatchControllerClient.PollOnceCreateBatchAsync(String, CallSettings)

BatchControllerClient.CreateBatch(String, Batch, String, CallSettings)

BatchControllerClient.CreateBatchAsync(String, Batch, String, CallSettings)

BatchControllerClient.CreateBatchAsync(String, Batch, String, CancellationToken)

BatchControllerClient.CreateBatch(LocationName, Batch, String, CallSettings)

BatchControllerClient.CreateBatchAsync(LocationName, Batch, String, CallSettings)

BatchControllerClient.CreateBatchAsync(LocationName, Batch, String, CancellationToken)

BatchControllerClient.GetBatchAsync(GetBatchRequest, CancellationToken)

BatchControllerClient.GetBatch(String, CallSettings)

BatchControllerClient.GetBatchAsync(String, CallSettings)

BatchControllerClient.GetBatchAsync(String, CancellationToken)

BatchControllerClient.GetBatch(BatchName, CallSettings)

BatchControllerClient.GetBatchAsync(BatchName, CallSettings)

BatchControllerClient.GetBatchAsync(BatchName, CancellationToken)

BatchControllerClient.ListBatches(String, String, Nullable<Int32>, CallSettings)

BatchControllerClient.ListBatchesAsync(String, String, Nullable<Int32>, CallSettings)

BatchControllerClient.ListBatches(LocationName, String, Nullable<Int32>, CallSettings)

BatchControllerClient.ListBatchesAsync(LocationName, String, Nullable<Int32>, CallSettings)

BatchControllerClient.DeleteBatchAsync(DeleteBatchRequest, CancellationToken)

BatchControllerClient.DeleteBatch(String, CallSettings)

BatchControllerClient.DeleteBatchAsync(String, CallSettings)

BatchControllerClient.DeleteBatchAsync(String, CancellationToken)

BatchControllerClient.DeleteBatch(BatchName, CallSettings)

BatchControllerClient.DeleteBatchAsync(BatchName, CallSettings)

BatchControllerClient.DeleteBatchAsync(BatchName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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
Name	Description
grpcClient	BatchController.BatchControllerClient The underlying gRPC client.
settings	BatchControllerSettings The base BatchControllerSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateBatchOperationsClient

public override OperationsClient CreateBatchOperationsClient { get; }

The long-running operations client for CreateBatch.

Property Value
Type	Description
OperationsClient

Overrides

BatchControllerClient.CreateBatchOperationsClient

GrpcClient

public override BatchController.BatchControllerClient GrpcClient { get; }

The underlying gRPC BatchController client

Property Value
Type	Description
BatchController.BatchControllerClient

Overrides

BatchControllerClient.GrpcClient

Methods

CreateBatch(CreateBatchRequest, CallSettings)

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

Creates a batch workload that executes asynchronously.

Parameters
Name	Description
request	CreateBatchRequest 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
Operation<Batch, BatchOperationMetadata>	The RPC response.

Overrides

BatchControllerClient.CreateBatch(CreateBatchRequest, CallSettings)

CreateBatchAsync(CreateBatchRequest, CallSettings)

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

Creates a batch workload that executes asynchronously.

Parameters
Name	Description
request	CreateBatchRequest 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
Task<Operation<Batch, BatchOperationMetadata>>	A Task containing the RPC response.

Overrides

BatchControllerClient.CreateBatchAsync(CreateBatchRequest, CallSettings)

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
Name	Description
request	DeleteBatchRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

BatchControllerClient.DeleteBatch(DeleteBatchRequest, CallSettings)

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
Name	Description
request	DeleteBatchRequest 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
Task	A Task containing the RPC response.

Overrides

BatchControllerClient.DeleteBatchAsync(DeleteBatchRequest, CallSettings)

GetBatch(GetBatchRequest, CallSettings)

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

Gets the batch workload resource representation.

Parameters
Name	Description
request	GetBatchRequest 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
Batch	The RPC response.

Overrides

BatchControllerClient.GetBatch(GetBatchRequest, CallSettings)

GetBatchAsync(GetBatchRequest, CallSettings)

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

Gets the batch workload resource representation.

Parameters
Name	Description
request	GetBatchRequest 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
Task<Batch>	A Task containing the RPC response.

Overrides

BatchControllerClient.GetBatchAsync(GetBatchRequest, CallSettings)

ListBatches(ListBatchesRequest, CallSettings)

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

Lists batch workloads.

Parameters
Name	Description
request	ListBatchesRequest 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
PagedEnumerable<ListBatchesResponse, Batch>	A pageable sequence of Batch resources.

Overrides

BatchControllerClient.ListBatches(ListBatchesRequest, CallSettings)

ListBatchesAsync(ListBatchesRequest, CallSettings)

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

Lists batch workloads.

Parameters
Name	Description
request	ListBatchesRequest 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
PagedAsyncEnumerable<ListBatchesResponse, Batch>	A pageable asynchronous sequence of Batch resources.

Overrides

BatchControllerClient.ListBatchesAsync(ListBatchesRequest, CallSettings)