@Generated(value="by gapic-generator-java") public class BatchControllerClient extends Object implements BackgroundResource
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
BatchName name = BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]");
Batch response = batchControllerClient.getBatch(name);
}
Note: close() needs to be called on the BatchControllerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of BatchControllerSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BatchControllerSettings batchControllerSettings =
BatchControllerSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
BatchControllerClient batchControllerClient =
BatchControllerClient.create(batchControllerSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BatchControllerSettings batchControllerSettings =
BatchControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
BatchControllerClient batchControllerClient =
BatchControllerClient.create(batchControllerSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
BatchControllerSettings batchControllerSettings =
BatchControllerSettings.newBuilder()
.setTransportChannelProvider(
BatchControllerSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
BatchControllerClient batchControllerClient =
BatchControllerClient.create(batchControllerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Modifier and Type | Class and Description |
---|---|
static class |
BatchControllerClient.ListBatchesFixedSizeCollection |
static class |
BatchControllerClient.ListBatchesPage |
static class |
BatchControllerClient.ListBatchesPagedResponse |
Modifier | Constructor and Description |
---|---|
protected |
BatchControllerClient(BatchControllerSettings settings)
Constructs an instance of BatchControllerClient, using the given settings.
|
protected |
BatchControllerClient(BatchControllerStub stub) |
Modifier and Type | Method and Description |
---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static BatchControllerClient |
create()
Constructs an instance of BatchControllerClient with default settings.
|
static BatchControllerClient |
create(BatchControllerSettings settings)
Constructs an instance of BatchControllerClient, using the given settings.
|
static BatchControllerClient |
create(BatchControllerStub stub)
Constructs an instance of BatchControllerClient, using the given stub for making calls.
|
OperationFuture<Batch,BatchOperationMetadata> |
createBatchAsync(CreateBatchRequest request)
Creates a batch workload that executes asynchronously.
|
OperationFuture<Batch,BatchOperationMetadata> |
createBatchAsync(LocationName parent,
Batch batch,
String batchId)
Creates a batch workload that executes asynchronously.
|
OperationFuture<Batch,BatchOperationMetadata> |
createBatchAsync(String parent,
Batch batch,
String batchId)
Creates a batch workload that executes asynchronously.
|
UnaryCallable<CreateBatchRequest,Operation> |
createBatchCallable()
Creates a batch workload that executes asynchronously.
|
OperationCallable<CreateBatchRequest,Batch,BatchOperationMetadata> |
createBatchOperationCallable()
Creates a batch workload that executes asynchronously.
|
void |
deleteBatch(BatchName name)
Deletes the batch workload resource.
|
void |
deleteBatch(DeleteBatchRequest request)
Deletes the batch workload resource.
|
void |
deleteBatch(String name)
Deletes the batch workload resource.
|
UnaryCallable<DeleteBatchRequest,Empty> |
deleteBatchCallable()
Deletes the batch workload resource.
|
Batch |
getBatch(BatchName name)
Gets the batch workload resource representation.
|
Batch |
getBatch(GetBatchRequest request)
Gets the batch workload resource representation.
|
Batch |
getBatch(String name)
Gets the batch workload resource representation.
|
UnaryCallable<GetBatchRequest,Batch> |
getBatchCallable()
Gets the batch workload resource representation.
|
OperationsClient |
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation
returned by another API method call.
|
OperationsClient |
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation
returned by another API method call.
|
BatchControllerSettings |
getSettings() |
BatchControllerStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
BatchControllerClient.ListBatchesPagedResponse |
listBatches(ListBatchesRequest request)
Lists batch workloads.
|
BatchControllerClient.ListBatchesPagedResponse |
listBatches(LocationName parent)
Lists batch workloads.
|
BatchControllerClient.ListBatchesPagedResponse |
listBatches(String parent)
Lists batch workloads.
|
UnaryCallable<ListBatchesRequest,ListBatchesResponse> |
listBatchesCallable()
Lists batch workloads.
|
UnaryCallable<ListBatchesRequest,BatchControllerClient.ListBatchesPagedResponse> |
listBatchesPagedCallable()
Lists batch workloads.
|
void |
shutdown() |
void |
shutdownNow() |
protected BatchControllerClient(BatchControllerSettings settings) throws IOException
IOException
protected BatchControllerClient(BatchControllerStub stub)
public static final BatchControllerClient create() throws IOException
IOException
public static final BatchControllerClient create(BatchControllerSettings settings) throws IOException
IOException
public static final BatchControllerClient create(BatchControllerStub stub)
public final BatchControllerSettings getSettings()
public BatchControllerStub getStub()
public final OperationsClient getOperationsClient()
@BetaApi public final OperationsClient getHttpJsonOperationsClient()
public final OperationFuture<Batch,BatchOperationMetadata> createBatchAsync(LocationName parent, Batch batch, String batchId)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Batch batch = Batch.newBuilder().build();
String batchId = "batchId-331744779";
Batch response = batchControllerClient.createBatchAsync(parent, batch, batchId).get();
}
parent
- Required. The parent resource where this batch will be created.batch
- Required. The batch to create.batchId
- 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 `/[a-z][0-9]-/`.
ApiException
- if the remote call failspublic final OperationFuture<Batch,BatchOperationMetadata> createBatchAsync(String parent, Batch batch, String batchId)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Batch batch = Batch.newBuilder().build();
String batchId = "batchId-331744779";
Batch response = batchControllerClient.createBatchAsync(parent, batch, batchId).get();
}
parent
- Required. The parent resource where this batch will be created.batch
- Required. The batch to create.batchId
- 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 `/[a-z][0-9]-/`.
ApiException
- if the remote call failspublic final OperationFuture<Batch,BatchOperationMetadata> createBatchAsync(CreateBatchRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
CreateBatchRequest request =
CreateBatchRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBatch(Batch.newBuilder().build())
.setBatchId("batchId-331744779")
.setRequestId("requestId693933066")
.build();
Batch response = batchControllerClient.createBatchAsync(request).get();
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final OperationCallable<CreateBatchRequest,Batch,BatchOperationMetadata> createBatchOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
CreateBatchRequest request =
CreateBatchRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBatch(Batch.newBuilder().build())
.setBatchId("batchId-331744779")
.setRequestId("requestId693933066")
.build();
OperationFuture<Batch, BatchOperationMetadata> future =
batchControllerClient.createBatchOperationCallable().futureCall(request);
// Do something.
Batch response = future.get();
}
public final UnaryCallable<CreateBatchRequest,Operation> createBatchCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
CreateBatchRequest request =
CreateBatchRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBatch(Batch.newBuilder().build())
.setBatchId("batchId-331744779")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = batchControllerClient.createBatchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final Batch getBatch(BatchName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
BatchName name = BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]");
Batch response = batchControllerClient.getBatch(name);
}
name
- Required. The name of the batch to retrieve.ApiException
- if the remote call failspublic final Batch getBatch(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
String name = BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]").toString();
Batch response = batchControllerClient.getBatch(name);
}
name
- Required. The name of the batch to retrieve.ApiException
- if the remote call failspublic final Batch getBatch(GetBatchRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
GetBatchRequest request =
GetBatchRequest.newBuilder()
.setName(BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]").toString())
.build();
Batch response = batchControllerClient.getBatch(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<GetBatchRequest,Batch> getBatchCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
GetBatchRequest request =
GetBatchRequest.newBuilder()
.setName(BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]").toString())
.build();
ApiFuture<Batch> future = batchControllerClient.getBatchCallable().futureCall(request);
// Do something.
Batch response = future.get();
}
public final BatchControllerClient.ListBatchesPagedResponse listBatches(LocationName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Batch element : batchControllerClient.listBatches(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent
- Required. The parent, which owns this collection of batches.ApiException
- if the remote call failspublic final BatchControllerClient.ListBatchesPagedResponse listBatches(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Batch element : batchControllerClient.listBatches(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent
- Required. The parent, which owns this collection of batches.ApiException
- if the remote call failspublic final BatchControllerClient.ListBatchesPagedResponse listBatches(ListBatchesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
ListBatchesRequest request =
ListBatchesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Batch element : batchControllerClient.listBatches(request).iterateAll()) {
// doThingsWith(element);
}
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<ListBatchesRequest,BatchControllerClient.ListBatchesPagedResponse> listBatchesPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
ListBatchesRequest request =
ListBatchesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Batch> future =
batchControllerClient.listBatchesPagedCallable().futureCall(request);
// Do something.
for (Batch element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final UnaryCallable<ListBatchesRequest,ListBatchesResponse> listBatchesCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
ListBatchesRequest request =
ListBatchesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListBatchesResponse response = batchControllerClient.listBatchesCallable().call(request);
for (Batch element : response.getBatchesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final void deleteBatch(BatchName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
BatchName name = BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]");
batchControllerClient.deleteBatch(name);
}
name
- Required. The name of the batch resource to delete.ApiException
- if the remote call failspublic final void deleteBatch(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
String name = BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]").toString();
batchControllerClient.deleteBatch(name);
}
name
- Required. The name of the batch resource to delete.ApiException
- if the remote call failspublic final void deleteBatch(DeleteBatchRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
DeleteBatchRequest request =
DeleteBatchRequest.newBuilder()
.setName(BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]").toString())
.build();
batchControllerClient.deleteBatch(request);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<DeleteBatchRequest,Empty> deleteBatchCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BatchControllerClient batchControllerClient = BatchControllerClient.create()) {
DeleteBatchRequest request =
DeleteBatchRequest.newBuilder()
.setName(BatchName.of("[PROJECT]", "[LOCATION]", "[BATCH]").toString())
.build();
ApiFuture<Empty> future = batchControllerClient.deleteBatchCallable().futureCall(request);
// Do something.
future.get();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2022 Google LLC. All rights reserved.