public class BatchControllerClient : ClientBase<BatchController.BatchControllerClient>
Client for BatchController
Inheritance
Object > ClientBase > ClientBase<BatchController.BatchControllerClient> > BatchController.BatchControllerClientNamespace
Google.Cloud.Dataproc.V1Assembly
Google.Cloud.Dataproc.V1.dll
Constructors
BatchControllerClient()
protected BatchControllerClient()
Protected parameterless constructor to allow creation of test doubles.
BatchControllerClient(CallInvoker)
public BatchControllerClient(CallInvoker callInvoker)
Creates a new client for BatchController that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker | CallInvoker The callInvoker to use to make remote calls. |
BatchControllerClient(ChannelBase)
public BatchControllerClient(ChannelBase channel)
Creates a new client for BatchController
Parameter | |
---|---|
Name | Description |
channel | ChannelBase The channel to use to make remote calls. |
BatchControllerClient(ClientBase.ClientBaseConfiguration)
protected BatchControllerClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration | ClientBase.ClientBaseConfiguration The client configuration. |
Methods
CreateBatch(CreateBatchRequest, CallOptions)
public virtual Operation CreateBatch(CreateBatchRequest request, CallOptions options)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
request | CreateBatchRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateBatch(CreateBatchRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateBatch(CreateBatchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
request | CreateBatchRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
Operation | The response received from the server. |
CreateBatchAsync(CreateBatchRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateBatchAsync(CreateBatchRequest request, CallOptions options)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
request | CreateBatchRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateBatchAsync(CreateBatchRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateBatchAsync(CreateBatchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
request | CreateBatchRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
AsyncUnaryCall<Operation> | The call object. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()
Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
Operations.OperationsClient | A new Operations client for the same target as this client. |
DeleteBatch(DeleteBatchRequest, CallOptions)
public virtual Empty DeleteBatch(DeleteBatchRequest request, CallOptions options)
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 to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
DeleteBatch(DeleteBatchRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Empty DeleteBatch(DeleteBatchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
Empty | The response received from the server. |
DeleteBatchAsync(DeleteBatchRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteBatchAsync(DeleteBatchRequest request, CallOptions options)
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 to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Empty> | The call object. |
DeleteBatchAsync(DeleteBatchRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteBatchAsync(DeleteBatchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
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 to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
AsyncUnaryCall<Empty> | The call object. |
GetBatch(GetBatchRequest, CallOptions)
public virtual Batch GetBatch(GetBatchRequest request, CallOptions options)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
request | GetBatchRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Batch | The response received from the server. |
GetBatch(GetBatchRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Batch GetBatch(GetBatchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
request | GetBatchRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
Batch | The response received from the server. |
GetBatchAsync(GetBatchRequest, CallOptions)
public virtual AsyncUnaryCall<Batch> GetBatchAsync(GetBatchRequest request, CallOptions options)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
request | GetBatchRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Batch> | The call object. |
GetBatchAsync(GetBatchRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Batch> GetBatchAsync(GetBatchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
request | GetBatchRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
AsyncUnaryCall<Batch> | The call object. |
ListBatches(ListBatchesRequest, CallOptions)
public virtual ListBatchesResponse ListBatches(ListBatchesRequest request, CallOptions options)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
request | ListBatchesRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListBatchesResponse | The response received from the server. |
ListBatches(ListBatchesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListBatchesResponse ListBatches(ListBatchesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
request | ListBatchesRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
ListBatchesResponse | The response received from the server. |
ListBatchesAsync(ListBatchesRequest, CallOptions)
public virtual AsyncUnaryCall<ListBatchesResponse> ListBatchesAsync(ListBatchesRequest request, CallOptions options)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
request | ListBatchesRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListBatchesResponse> | The call object. |
ListBatchesAsync(ListBatchesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListBatchesResponse> ListBatchesAsync(ListBatchesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
request | ListBatchesRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<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 |
AsyncUnaryCall<ListBatchesResponse> | The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
protected override BatchController.BatchControllerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration | ClientBase.ClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
BatchController.BatchControllerClient |