public abstract class BatchControllerClient
BatchController client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Dataproc.V1Assembly
Google.Cloud.Dataproc.V1.dll
Remarks
The BatchController provides methods to manage batch workloads.
Properties
CreateBatchOperationsClient
public virtual OperationsClient CreateBatchOperationsClient { get; }
The long-running operations client for CreateBatch
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the BatchController service, which is a host of "dataproc.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
String |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default BatchController scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyList<String> |
The default BatchController scopes are:
GrpcClient
public virtual BatchController.BatchControllerClient GrpcClient { get; }
The underlying gRPC BatchController client
Property Value | |
---|---|
Type | Description |
BatchController.BatchControllerClient |
Methods
Create()
public static BatchControllerClient Create()
Synchronously creates a BatchControllerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BatchControllerClientBuilder.
Returns | |
---|---|
Type | Description |
BatchControllerClient | The created BatchControllerClient. |
CreateAsync(CancellationToken)
public static Task<BatchControllerClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a BatchControllerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BatchControllerClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
Task<BatchControllerClient> | The task representing the created BatchControllerClient. |
CreateBatch(LocationName, Batch, String, CallSettings)
public virtual Operation<Batch, BatchOperationMetadata> CreateBatch(LocationName parent, Batch batch, string batchId, CallSettings callSettings = null)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource where this batch will be created. |
batch | Batch Required. The batch to create. |
batchId | String Optional. The ID to use for the batch, which will become the final component of the batch's resource name. This value must be 4-63 characters. Valid characters are |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Batch, BatchOperationMetadata> | The RPC response. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Batch batch = new Batch();
string batchId = "";
// Make the request
Operation<Batch, BatchOperationMetadata> response = batchControllerClient.CreateBatch(parent, batch, batchId);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = batchControllerClient.PollOnceCreateBatch(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatch(CreateBatchRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
CreateBatchRequest request = new CreateBatchRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Batch = new Batch(),
BatchId = "",
RequestId = "",
};
// Make the request
Operation<Batch, BatchOperationMetadata> response = batchControllerClient.CreateBatch(request);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = batchControllerClient.PollOnceCreateBatch(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatch(String, Batch, String, CallSettings)
public virtual Operation<Batch, BatchOperationMetadata> CreateBatch(string parent, Batch batch, string batchId, CallSettings callSettings = null)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent resource where this batch will be created. |
batch | Batch Required. The batch to create. |
batchId | String Optional. The ID to use for the batch, which will become the final component of the batch's resource name. This value must be 4-63 characters. Valid characters are |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Batch, BatchOperationMetadata> | The RPC response. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Batch batch = new Batch();
string batchId = "";
// Make the request
Operation<Batch, BatchOperationMetadata> response = batchControllerClient.CreateBatch(parent, batch, batchId);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = batchControllerClient.PollOnceCreateBatch(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatchAsync(LocationName, Batch, String, CallSettings)
public virtual Task<Operation<Batch, BatchOperationMetadata>> CreateBatchAsync(LocationName parent, Batch batch, string batchId, CallSettings callSettings = null)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource where this batch will be created. |
batch | Batch Required. The batch to create. |
batchId | String Optional. The ID to use for the batch, which will become the final component of the batch's resource name. This value must be 4-63 characters. Valid characters are |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Batch, BatchOperationMetadata>> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Batch batch = new Batch();
string batchId = "";
// Make the request
Operation<Batch, BatchOperationMetadata> response = await batchControllerClient.CreateBatchAsync(parent, batch, batchId);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = await batchControllerClient.PollOnceCreateBatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatchAsync(LocationName, Batch, String, CancellationToken)
public virtual Task<Operation<Batch, BatchOperationMetadata>> CreateBatchAsync(LocationName parent, Batch batch, string batchId, CancellationToken cancellationToken)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource where this batch will be created. |
batch | Batch Required. The batch to create. |
batchId | String Optional. The ID to use for the batch, which will become the final component of the batch's resource name. This value must be 4-63 characters. Valid characters are |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Batch, BatchOperationMetadata>> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Batch batch = new Batch();
string batchId = "";
// Make the request
Operation<Batch, BatchOperationMetadata> response = await batchControllerClient.CreateBatchAsync(parent, batch, batchId);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = await batchControllerClient.PollOnceCreateBatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatchAsync(CreateBatchRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
CreateBatchRequest request = new CreateBatchRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Batch = new Batch(),
BatchId = "",
RequestId = "",
};
// Make the request
Operation<Batch, BatchOperationMetadata> response = await batchControllerClient.CreateBatchAsync(request);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = await batchControllerClient.PollOnceCreateBatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatchAsync(CreateBatchRequest, CancellationToken)
public virtual Task<Operation<Batch, BatchOperationMetadata>> CreateBatchAsync(CreateBatchRequest request, CancellationToken cancellationToken)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
request | CreateBatchRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Batch, BatchOperationMetadata>> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
CreateBatchRequest request = new CreateBatchRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
Batch = new Batch(),
BatchId = "",
RequestId = "",
};
// Make the request
Operation<Batch, BatchOperationMetadata> response = await batchControllerClient.CreateBatchAsync(request);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = await batchControllerClient.PollOnceCreateBatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatchAsync(String, Batch, String, CallSettings)
public virtual Task<Operation<Batch, BatchOperationMetadata>> CreateBatchAsync(string parent, Batch batch, string batchId, CallSettings callSettings = null)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent resource where this batch will be created. |
batch | Batch Required. The batch to create. |
batchId | String Optional. The ID to use for the batch, which will become the final component of the batch's resource name. This value must be 4-63 characters. Valid characters are |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Batch, BatchOperationMetadata>> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Batch batch = new Batch();
string batchId = "";
// Make the request
Operation<Batch, BatchOperationMetadata> response = await batchControllerClient.CreateBatchAsync(parent, batch, batchId);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = await batchControllerClient.PollOnceCreateBatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
CreateBatchAsync(String, Batch, String, CancellationToken)
public virtual Task<Operation<Batch, BatchOperationMetadata>> CreateBatchAsync(string parent, Batch batch, string batchId, CancellationToken cancellationToken)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent resource where this batch will be created. |
batch | Batch Required. The batch to create. |
batchId | String Optional. The ID to use for the batch, which will become the final component of the batch's resource name. This value must be 4-63 characters. Valid characters are |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Operation<Batch, BatchOperationMetadata>> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Batch batch = new Batch();
string batchId = "";
// Make the request
Operation<Batch, BatchOperationMetadata> response = await batchControllerClient.CreateBatchAsync(parent, batch, batchId);
// Poll until the returned long-running operation is complete
Operation<Batch, BatchOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Batch result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Batch, BatchOperationMetadata> retrievedResponse = await batchControllerClient.PollOnceCreateBatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Batch retrievedResult = retrievedResponse.Result;
}
DeleteBatch(BatchName, CallSettings)
public virtual void DeleteBatch(BatchName name, 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 |
name | BatchName Required. The name of the batch resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
BatchName name = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]");
// Make the request
batchControllerClient.DeleteBatch(name);
DeleteBatch(DeleteBatchRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
DeleteBatchRequest request = new DeleteBatchRequest
{
BatchName = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]"),
};
// Make the request
batchControllerClient.DeleteBatch(request);
DeleteBatch(String, CallSettings)
public virtual void DeleteBatch(string name, 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 |
name | String Required. The name of the batch resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batches/[BATCH]";
// Make the request
batchControllerClient.DeleteBatch(name);
DeleteBatchAsync(BatchName, CallSettings)
public virtual Task DeleteBatchAsync(BatchName name, 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 |
name | BatchName Required. The name of the batch resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
BatchName name = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]");
// Make the request
await batchControllerClient.DeleteBatchAsync(name);
DeleteBatchAsync(BatchName, CancellationToken)
public virtual Task DeleteBatchAsync(BatchName name, CancellationToken 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 |
name | BatchName Required. The name of the batch resource to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
BatchName name = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]");
// Make the request
await batchControllerClient.DeleteBatchAsync(name);
DeleteBatchAsync(DeleteBatchRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
DeleteBatchRequest request = new DeleteBatchRequest
{
BatchName = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]"),
};
// Make the request
await batchControllerClient.DeleteBatchAsync(request);
DeleteBatchAsync(DeleteBatchRequest, CancellationToken)
public virtual Task DeleteBatchAsync(DeleteBatchRequest request, CancellationToken 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 object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
DeleteBatchRequest request = new DeleteBatchRequest
{
BatchName = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]"),
};
// Make the request
await batchControllerClient.DeleteBatchAsync(request);
DeleteBatchAsync(String, CallSettings)
public virtual Task DeleteBatchAsync(string name, 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 |
name | String Required. The name of the batch resource to delete. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batches/[BATCH]";
// Make the request
await batchControllerClient.DeleteBatchAsync(name);
DeleteBatchAsync(String, CancellationToken)
public virtual Task DeleteBatchAsync(string name, CancellationToken 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 |
name | String Required. The name of the batch resource to delete. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batches/[BATCH]";
// Make the request
await batchControllerClient.DeleteBatchAsync(name);
GetBatch(BatchName, CallSettings)
public virtual Batch GetBatch(BatchName name, CallSettings callSettings = null)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
name | BatchName Required. The name of the batch to retrieve. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Batch | The RPC response. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
BatchName name = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]");
// Make the request
Batch response = batchControllerClient.GetBatch(name);
GetBatch(GetBatchRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
GetBatchRequest request = new GetBatchRequest
{
BatchName = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]"),
};
// Make the request
Batch response = batchControllerClient.GetBatch(request);
GetBatch(String, CallSettings)
public virtual Batch GetBatch(string name, CallSettings callSettings = null)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the batch to retrieve. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Batch | The RPC response. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batches/[BATCH]";
// Make the request
Batch response = batchControllerClient.GetBatch(name);
GetBatchAsync(BatchName, CallSettings)
public virtual Task<Batch> GetBatchAsync(BatchName name, CallSettings callSettings = null)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
name | BatchName Required. The name of the batch to retrieve. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Batch> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
BatchName name = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]");
// Make the request
Batch response = await batchControllerClient.GetBatchAsync(name);
GetBatchAsync(BatchName, CancellationToken)
public virtual Task<Batch> GetBatchAsync(BatchName name, CancellationToken cancellationToken)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
name | BatchName Required. The name of the batch to retrieve. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Batch> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
BatchName name = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]");
// Make the request
Batch response = await batchControllerClient.GetBatchAsync(name);
GetBatchAsync(GetBatchRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
GetBatchRequest request = new GetBatchRequest
{
BatchName = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]"),
};
// Make the request
Batch response = await batchControllerClient.GetBatchAsync(request);
GetBatchAsync(GetBatchRequest, CancellationToken)
public virtual Task<Batch> GetBatchAsync(GetBatchRequest request, CancellationToken cancellationToken)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
request | GetBatchRequest The request object containing all of the parameters for the API call. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Batch> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
GetBatchRequest request = new GetBatchRequest
{
BatchName = BatchName.FromProjectLocationBatch("[PROJECT]", "[LOCATION]", "[BATCH]"),
};
// Make the request
Batch response = await batchControllerClient.GetBatchAsync(request);
GetBatchAsync(String, CallSettings)
public virtual Task<Batch> GetBatchAsync(string name, CallSettings callSettings = null)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the batch to retrieve. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Batch> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batches/[BATCH]";
// Make the request
Batch response = await batchControllerClient.GetBatchAsync(name);
GetBatchAsync(String, CancellationToken)
public virtual Task<Batch> GetBatchAsync(string name, CancellationToken cancellationToken)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
name | String Required. The name of the batch to retrieve. |
cancellationToken | CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task<Batch> | A Task containing the RPC response. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/batches/[BATCH]";
// Make the request
Batch response = await batchControllerClient.GetBatchAsync(name);
ListBatches(LocationName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListBatchesResponse, Batch> ListBatches(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent, which owns this collection of batches. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListBatchesResponse, Batch> | A pageable sequence of Batch resources. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListBatchesResponse, Batch> response = batchControllerClient.ListBatches(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Batch item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBatchesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Batch item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Batch> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Batch item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBatches(ListBatchesRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
ListBatchesRequest request = new ListBatchesRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListBatchesResponse, Batch> response = batchControllerClient.ListBatches(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Batch item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBatchesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Batch item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Batch> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Batch item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBatches(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListBatchesResponse, Batch> ListBatches(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of batches. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListBatchesResponse, Batch> | A pageable sequence of Batch resources. |
// Create client
BatchControllerClient batchControllerClient = BatchControllerClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListBatchesResponse, Batch> response = batchControllerClient.ListBatches(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Batch item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListBatchesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Batch item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Batch> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Batch item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBatchesAsync(LocationName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListBatchesResponse, Batch> ListBatchesAsync(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent, which owns this collection of batches. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListBatchesResponse, Batch> | A pageable asynchronous sequence of Batch resources. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListBatchesResponse, Batch> response = batchControllerClient.ListBatchesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Batch item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBatchesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Batch item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Batch> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Batch item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBatchesAsync(ListBatchesRequest, CallSettings)
public virtual 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. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
ListBatchesRequest request = new ListBatchesRequest
{
ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListBatchesResponse, Batch> response = batchControllerClient.ListBatchesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Batch item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBatchesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Batch item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Batch> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Batch item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListBatchesAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListBatchesResponse, Batch> ListBatchesAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of batches. |
pageToken | String The token returned from the previous request. A value of |
pageSize | Nullable<Int32> The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListBatchesResponse, Batch> | A pageable asynchronous sequence of Batch resources. |
// Create client
BatchControllerClient batchControllerClient = await BatchControllerClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListBatchesResponse, Batch> response = batchControllerClient.ListBatchesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Batch item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListBatchesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Batch item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Batch> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Batch item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
PollOnceCreateBatch(String, CallSettings)
public virtual Operation<Batch, BatchOperationMetadata> PollOnceCreateBatch(string operationName, CallSettings callSettings = null)
Poll an operation once, using an operationName
from a previous invocation of CreateBatch
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Batch, BatchOperationMetadata> | The result of polling the operation. |
PollOnceCreateBatchAsync(String, CallSettings)
public virtual Task<Operation<Batch, BatchOperationMetadata>> PollOnceCreateBatchAsync(string operationName, CallSettings callSettings = null)
Asynchronously poll an operation once, using an operationName
from a previous invocation of
CreateBatch
.
Parameters | |
---|---|
Name | Description |
operationName | String The name of a previously invoked operation. Must not be |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Batch, BatchOperationMetadata>> | A task representing the result of polling the operation. |
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task | A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.