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.
Namespace
Google.Cloud.Dataproc.V1Assembly
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 |
GrpcClient
public override BatchController.BatchControllerClient GrpcClient { get; }
The underlying gRPC BatchController client
Property Value | |
---|---|
Type | Description |
BatchController.BatchControllerClient |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |