Google Cloud Dataproc v1 API - Class BatchController.BatchControllerClient (5.5.0)

Version 5.5.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 class BatchController.BatchControllerClient : ClientBase<BatchController.BatchControllerClient>

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

Client for BatchController

Inheritance

object > ClientBase > ClientBaseBatchControllerBatchControllerClient > BatchController.BatchControllerClient

Inherited Members

ClientBase<BatchController.BatchControllerClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.DataprocV1

Assembly

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(ClientBaseConfiguration)

protected BatchControllerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration 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, DateTime?, CancellationToken)

public virtual Operation CreateBatch(CreateBatchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallOperation	The call object.

CreateBatchAsync(CreateBatchRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateBatchAsync(CreateBatchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallOperation	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	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, DateTime?, CancellationToken)

public virtual Empty DeleteBatch(DeleteBatchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallEmpty	The call object.

DeleteBatchAsync(DeleteBatchRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteBatchAsync(DeleteBatchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallEmpty	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, DateTime?, CancellationToken)

public virtual Batch GetBatch(GetBatchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallBatch	The call object.

GetBatchAsync(GetBatchRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Batch> GetBatchAsync(GetBatchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallBatch	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, DateTime?, CancellationToken)

public virtual ListBatchesResponse ListBatches(ListBatchesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallListBatchesResponse	The call object.

ListBatchesAsync(ListBatchesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBatchesResponse> ListBatchesAsync(ListBatchesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	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
AsyncUnaryCallListBatchesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override BatchController.BatchControllerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
BatchControllerBatchControllerClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dataproc.V1.BatchController.BatchControllerClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)