com.google.cloud.dataproc.v1.BatchControllerClient Maven / Gradle / Ivy
Show all versions of google-cloud-dataproc Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.dataproc.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.dataproc.v1.stub.BatchControllerStub;
import com.google.cloud.dataproc.v1.stub.BatchControllerStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: The BatchController provides methods to manage batch workloads.
*
* 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:
*
*
{@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);
* }
* }
*
* 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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* CreateBatch
Creates a batch workload that executes asynchronously.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createBatchAsync(CreateBatchRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* createBatchAsync(LocationName parent, Batch batch, String batchId)
*
createBatchAsync(String parent, Batch batch, String batchId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createBatchOperationCallable()
*
createBatchCallable()
*
*
*
*
* GetBatch
Gets the batch workload resource representation.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getBatch(GetBatchRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getBatch(BatchName name)
*
getBatch(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getBatchCallable()
*
*
*
*
* ListBatches
Lists batch workloads.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listBatches(ListBatchesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listBatches(LocationName parent)
*
listBatches(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listBatchesPagedCallable()
*
listBatchesCallable()
*
*
*
*
* DeleteBatch
Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns `FAILED_PRECONDITION`.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteBatch(DeleteBatchRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteBatch(BatchName name)
*
deleteBatch(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteBatchCallable()
*
*
*
*
* SetIamPolicy
Sets the access control policy on the specified resource. Replacesany existing policy.
*
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* setIamPolicy(SetIamPolicyRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* setIamPolicyCallable()
*
*
*
*
* GetIamPolicy
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getIamPolicy(GetIamPolicyRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getIamPolicyCallable()
*
*
*
*
* TestIamPermissions
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.
*
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* testIamPermissions(TestIamPermissionsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* testIamPermissionsCallable()
*
*
*
*
*
* 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:
*
*
{@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
* BatchControllerSettings batchControllerSettings =
* BatchControllerSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* BatchControllerClient batchControllerClient =
* BatchControllerClient.create(batchControllerSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* BatchControllerSettings batchControllerSettings =
* BatchControllerSettings.newHttpJsonBuilder().build();
* BatchControllerClient batchControllerClient =
* BatchControllerClient.create(batchControllerSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class BatchControllerClient implements BackgroundResource {
private final BatchControllerSettings settings;
private final BatchControllerStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of BatchControllerClient with default settings. */
public static final BatchControllerClient create() throws IOException {
return create(BatchControllerSettings.newBuilder().build());
}
/**
* Constructs an instance of BatchControllerClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final BatchControllerClient create(BatchControllerSettings settings)
throws IOException {
return new BatchControllerClient(settings);
}
/**
* Constructs an instance of BatchControllerClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(BatchControllerSettings).
*/
public static final BatchControllerClient create(BatchControllerStub stub) {
return new BatchControllerClient(stub);
}
/**
* Constructs an instance of BatchControllerClient, using the given settings. This is protected so
* that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected BatchControllerClient(BatchControllerSettings settings) throws IOException {
this.settings = settings;
this.stub = ((BatchControllerStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected BatchControllerClient(BatchControllerStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final BatchControllerSettings getSettings() {
return settings;
}
public BatchControllerStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a batch workload that executes asynchronously.
*
*
Sample code:
*
*
{@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();
* }
* }
*
* @param parent Required. The parent resource where this batch will be created.
* @param batch Required. The batch to create.
* @param 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]-/`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createBatchAsync(
LocationName parent, Batch batch, String batchId) {
CreateBatchRequest request =
CreateBatchRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setBatch(batch)
.setBatchId(batchId)
.build();
return createBatchAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a batch workload that executes asynchronously.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param parent Required. The parent resource where this batch will be created.
* @param batch Required. The batch to create.
* @param 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]-/`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createBatchAsync(
String parent, Batch batch, String batchId) {
CreateBatchRequest request =
CreateBatchRequest.newBuilder()
.setParent(parent)
.setBatch(batch)
.setBatchId(batchId)
.build();
return createBatchAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a batch workload that executes asynchronously.
*
* Sample code:
*
*
{@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();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createBatchAsync(
CreateBatchRequest request) {
return createBatchOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a batch workload that executes asynchronously.
*
* Sample code:
*
*
{@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 future =
* batchControllerClient.createBatchOperationCallable().futureCall(request);
* // Do something.
* Batch response = future.get();
* }
* }
*/
public final OperationCallable
createBatchOperationCallable() {
return stub.createBatchOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a batch workload that executes asynchronously.
*
* Sample code:
*
*
{@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 future = batchControllerClient.createBatchCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable createBatchCallable() {
return stub.createBatchCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the batch workload resource representation.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The fully qualified name of the batch to retrieve in the format
* "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Batch getBatch(BatchName name) {
GetBatchRequest request =
GetBatchRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getBatch(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the batch workload resource representation.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The fully qualified name of the batch to retrieve in the format
* "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Batch getBatch(String name) {
GetBatchRequest request = GetBatchRequest.newBuilder().setName(name).build();
return getBatch(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the batch workload resource representation.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Batch getBatch(GetBatchRequest request) {
return getBatchCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the batch workload resource representation.
*
* Sample code:
*
*
{@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 future = batchControllerClient.getBatchCallable().futureCall(request);
* // Do something.
* Batch response = future.get();
* }
* }
*/
public final UnaryCallable getBatchCallable() {
return stub.getBatchCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists batch workloads.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of batches.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListBatchesPagedResponse listBatches(LocationName parent) {
ListBatchesRequest request =
ListBatchesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listBatches(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists batch workloads.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of batches.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListBatchesPagedResponse listBatches(String parent) {
ListBatchesRequest request = ListBatchesRequest.newBuilder().setParent(parent).build();
return listBatches(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists batch workloads.
*
* Sample code:
*
*
{@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")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* for (Batch element : batchControllerClient.listBatches(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListBatchesPagedResponse listBatches(ListBatchesRequest request) {
return listBatchesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists batch workloads.
*
* Sample code:
*
*
{@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")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .build();
* ApiFuture future =
* batchControllerClient.listBatchesPagedCallable().futureCall(request);
* // Do something.
* for (Batch element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listBatchesPagedCallable() {
return stub.listBatchesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists batch workloads.
*
* Sample code:
*
*
{@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")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .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 UnaryCallable listBatchesCallable() {
return stub.listBatchesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the batch workload resource. If the batch is not in terminal state, the delete fails
* and the response returns `FAILED_PRECONDITION`.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The fully qualified name of the batch to retrieve in the format
* "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteBatch(BatchName name) {
DeleteBatchRequest request =
DeleteBatchRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteBatch(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the batch workload resource. If the batch is not in terminal state, the delete fails
* and the response returns `FAILED_PRECONDITION`.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The fully qualified name of the batch to retrieve in the format
* "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteBatch(String name) {
DeleteBatchRequest request = DeleteBatchRequest.newBuilder().setName(name).build();
deleteBatch(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the batch workload resource. If the batch is not in terminal state, the delete fails
* and the response returns `FAILED_PRECONDITION`.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteBatch(DeleteBatchRequest request) {
deleteBatchCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the batch workload resource. If the batch is not in terminal state, the delete fails
* and the response returns `FAILED_PRECONDITION`.
*
* Sample code:
*
*
{@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 future = batchControllerClient.deleteBatchCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteBatchCallable() {
return stub.deleteBatchCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replacesany existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
*
*
Sample code:
*
*
{@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()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(
* AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
* "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
* .toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Policy response = batchControllerClient.setIamPolicy(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replacesany existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
*
*
Sample code:
*
*
{@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()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(
* AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
* "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
* .toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future = batchControllerClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policyif the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(
* AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
* "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
* .toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* Policy response = batchControllerClient.getIamPolicy(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policyif the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(
* AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
* "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
* .toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* ApiFuture future = batchControllerClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified resource. If theresource does not exist,
* this will return an empty set ofpermissions, not a `NOT_FOUND` error.
*
* Note: This operation is designed to be used for buildingpermission-aware UIs and
* command-line tools, not for authorizationchecking. This operation may "fail open" without
* warning.
*
*
Sample code:
*
*
{@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()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(
* AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
* "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
* .toString())
* .addAllPermissions(new ArrayList())
* .build();
* TestIamPermissionsResponse response = batchControllerClient.testIamPermissions(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified resource. If theresource does not exist,
* this will return an empty set ofpermissions, not a `NOT_FOUND` error.
*
* Note: This operation is designed to be used for buildingpermission-aware UIs and
* command-line tools, not for authorizationchecking. This operation may "fail open" without
* warning.
*
*
Sample code:
*
*
{@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()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(
* AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
* "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
* .toString())
* .addAllPermissions(new ArrayList())
* .build();
* ApiFuture future =
* batchControllerClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListBatchesPagedResponse
extends AbstractPagedListResponse<
ListBatchesRequest,
ListBatchesResponse,
Batch,
ListBatchesPage,
ListBatchesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListBatchesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new ListBatchesPagedResponse(input), MoreExecutors.directExecutor());
}
private ListBatchesPagedResponse(ListBatchesPage page) {
super(page, ListBatchesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListBatchesPage
extends AbstractPage {
private ListBatchesPage(
PageContext context,
ListBatchesResponse response) {
super(context, response);
}
private static ListBatchesPage createEmptyPage() {
return new ListBatchesPage(null, null);
}
@Override
protected ListBatchesPage createPage(
PageContext context,
ListBatchesResponse response) {
return new ListBatchesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListBatchesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListBatchesRequest,
ListBatchesResponse,
Batch,
ListBatchesPage,
ListBatchesFixedSizeCollection> {
private ListBatchesFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListBatchesFixedSizeCollection createEmptyCollection() {
return new ListBatchesFixedSizeCollection(null, 0);
}
@Override
protected ListBatchesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListBatchesFixedSizeCollection(pages, collectionSize);
}
}
}