com.google.ads.googleads.v17.services.BatchJobServiceClient Maven / Gradle / Ivy
Show all versions of google-ads-stubs-v17 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.ads.googleads.v17.services;
import com.google.ads.googleads.v17.resources.BatchJob;
import com.google.ads.googleads.v17.resources.BatchJobName;
import com.google.ads.googleads.v17.services.stub.BatchJobServiceStub;
import com.google.ads.googleads.v17.services.stub.BatchJobServiceStubSettings;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
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.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
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: Service to manage batch jobs.
*
* 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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* String customerId = "customerId-1581184615";
* BatchJobOperation operation = BatchJobOperation.newBuilder().build();
* MutateBatchJobResponse response = batchJobServiceClient.mutateBatchJob(customerId, operation);
* }
* }
*
* Note: close() needs to be called on the BatchJobServiceClient 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
*
*
* MutateBatchJob
Mutates a batch job.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* mutateBatchJob(MutateBatchJobRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* mutateBatchJob(String customerId, BatchJobOperation operation)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* mutateBatchJobCallable()
*
*
*
*
* ListBatchJobResults
Returns the results of the batch job. The job must be done. Supports standard list paging.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listBatchJobResults(ListBatchJobResultsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listBatchJobResults(BatchJobName resourceName)
*
listBatchJobResults(String resourceName)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listBatchJobResultsPagedCallable()
*
listBatchJobResultsCallable()
*
*
*
*
* RunBatchJob
Runs the batch job.
*
The Operation.metadata field type is BatchJobMetadata. When finished, the long running operation will not contain errors or a response. Instead, use ListBatchJobResults to get the results of the job.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* runBatchJobAsync(RunBatchJobRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* runBatchJobAsync(BatchJobName resourceName)
*
runBatchJobAsync(String resourceName)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* runBatchJobOperationCallable()
*
runBatchJobCallable()
*
*
*
*
* AddBatchJobOperations
Add operations to the batch job.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* addBatchJobOperations(AddBatchJobOperationsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* addBatchJobOperations(BatchJobName resourceName, List<MutateOperation> mutateOperations)
*
addBatchJobOperations(String resourceName, List<MutateOperation> mutateOperations)
*
addBatchJobOperations(BatchJobName resourceName, String sequenceToken, List<MutateOperation> mutateOperations)
*
addBatchJobOperations(String resourceName, String sequenceToken, List<MutateOperation> mutateOperations)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* addBatchJobOperationsCallable()
*
*
*
*
*
* 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 BatchJobServiceSettings 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
* BatchJobServiceSettings batchJobServiceSettings =
* BatchJobServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* BatchJobServiceClient batchJobServiceClient =
* BatchJobServiceClient.create(batchJobServiceSettings);
* }
*
* 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
* BatchJobServiceSettings batchJobServiceSettings =
* BatchJobServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* BatchJobServiceClient batchJobServiceClient =
* BatchJobServiceClient.create(batchJobServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class BatchJobServiceClient implements BackgroundResource {
private final BatchJobServiceSettings settings;
private final BatchJobServiceStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of BatchJobServiceClient with default settings. */
public static final BatchJobServiceClient create() throws IOException {
return create(BatchJobServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of BatchJobServiceClient, 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 BatchJobServiceClient create(BatchJobServiceSettings settings)
throws IOException {
return new BatchJobServiceClient(settings);
}
/**
* Constructs an instance of BatchJobServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(BatchJobServiceSettings).
*/
public static final BatchJobServiceClient create(BatchJobServiceStub stub) {
return new BatchJobServiceClient(stub);
}
/**
* Constructs an instance of BatchJobServiceClient, 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 BatchJobServiceClient(BatchJobServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((BatchJobServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
protected BatchJobServiceClient(BatchJobServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final BatchJobServiceSettings getSettings() {
return settings;
}
public BatchJobServiceStub 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 OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Mutates a batch job.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* String customerId = "customerId-1581184615";
* BatchJobOperation operation = BatchJobOperation.newBuilder().build();
* MutateBatchJobResponse response = batchJobServiceClient.mutateBatchJob(customerId, operation);
* }
* }
*
* @param customerId Required. The ID of the customer for which to create a batch job.
* @param operation Required. The operation to perform on an individual batch job.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final MutateBatchJobResponse mutateBatchJob(
String customerId, BatchJobOperation operation) {
MutateBatchJobRequest request =
MutateBatchJobRequest.newBuilder()
.setCustomerId(customerId)
.setOperation(operation)
.build();
return mutateBatchJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Mutates a batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* MutateBatchJobRequest request =
* MutateBatchJobRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .setOperation(BatchJobOperation.newBuilder().build())
* .build();
* MutateBatchJobResponse response = batchJobServiceClient.mutateBatchJob(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 MutateBatchJobResponse mutateBatchJob(MutateBatchJobRequest request) {
return mutateBatchJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Mutates a batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* MutateBatchJobRequest request =
* MutateBatchJobRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .setOperation(BatchJobOperation.newBuilder().build())
* .build();
* ApiFuture future =
* batchJobServiceClient.mutateBatchJobCallable().futureCall(request);
* // Do something.
* MutateBatchJobResponse response = future.get();
* }
* }
*/
public final UnaryCallable
mutateBatchJobCallable() {
return stub.mutateBatchJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the results of the batch job. The job must be done. Supports standard list paging.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* BatchJobName resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]");
* for (BatchJobResult element :
* batchJobServiceClient.listBatchJobResults(resourceName).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param resourceName Required. The resource name of the batch job whose results are being
* listed.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListBatchJobResultsPagedResponse listBatchJobResults(BatchJobName resourceName) {
ListBatchJobResultsRequest request =
ListBatchJobResultsRequest.newBuilder()
.setResourceName(resourceName == null ? null : resourceName.toString())
.build();
return listBatchJobResults(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the results of the batch job. The job must be done. Supports standard list paging.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* String resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString();
* for (BatchJobResult element :
* batchJobServiceClient.listBatchJobResults(resourceName).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param resourceName Required. The resource name of the batch job whose results are being
* listed.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListBatchJobResultsPagedResponse listBatchJobResults(String resourceName) {
ListBatchJobResultsRequest request =
ListBatchJobResultsRequest.newBuilder().setResourceName(resourceName).build();
return listBatchJobResults(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the results of the batch job. The job must be done. Supports standard list paging.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* ListBatchJobResultsRequest request =
* ListBatchJobResultsRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* for (BatchJobResult element :
* batchJobServiceClient.listBatchJobResults(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 ListBatchJobResultsPagedResponse listBatchJobResults(
ListBatchJobResultsRequest request) {
return listBatchJobResultsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the results of the batch job. The job must be done. Supports standard list paging.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* ListBatchJobResultsRequest request =
* ListBatchJobResultsRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* ApiFuture future =
* batchJobServiceClient.listBatchJobResultsPagedCallable().futureCall(request);
* // Do something.
* for (BatchJobResult element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listBatchJobResultsPagedCallable() {
return stub.listBatchJobResultsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the results of the batch job. The job must be done. Supports standard list paging.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* ListBatchJobResultsRequest request =
* ListBatchJobResultsRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* while (true) {
* ListBatchJobResultsResponse response =
* batchJobServiceClient.listBatchJobResultsCallable().call(request);
* for (BatchJobResult element : response.getResultsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listBatchJobResultsCallable() {
return stub.listBatchJobResultsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Runs the batch job.
*
* The Operation.metadata field type is BatchJobMetadata. When finished, the long running
* operation will not contain errors or a response. Instead, use ListBatchJobResults to get the
* results of the job.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* BatchJobName resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]");
* batchJobServiceClient.runBatchJobAsync(resourceName).get();
* }
* }
*
* @param resourceName Required. The resource name of the BatchJob to run.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture runBatchJobAsync(
BatchJobName resourceName) {
RunBatchJobRequest request =
RunBatchJobRequest.newBuilder()
.setResourceName(resourceName == null ? null : resourceName.toString())
.build();
return runBatchJobAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Runs the batch job.
*
* The Operation.metadata field type is BatchJobMetadata. When finished, the long running
* operation will not contain errors or a response. Instead, use ListBatchJobResults to get the
* results of the job.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* String resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString();
* batchJobServiceClient.runBatchJobAsync(resourceName).get();
* }
* }
*
* @param resourceName Required. The resource name of the BatchJob to run.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture runBatchJobAsync(
String resourceName) {
RunBatchJobRequest request =
RunBatchJobRequest.newBuilder().setResourceName(resourceName).build();
return runBatchJobAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Runs the batch job.
*
* The Operation.metadata field type is BatchJobMetadata. When finished, the long running
* operation will not contain errors or a response. Instead, use ListBatchJobResults to get the
* results of the job.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* RunBatchJobRequest request =
* RunBatchJobRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .build();
* batchJobServiceClient.runBatchJobAsync(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 runBatchJobAsync(
RunBatchJobRequest request) {
return runBatchJobOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Runs the batch job.
*
* The Operation.metadata field type is BatchJobMetadata. When finished, the long running
* operation will not contain errors or a response. Instead, use ListBatchJobResults to get the
* results of the job.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* RunBatchJobRequest request =
* RunBatchJobRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .build();
* OperationFuture future =
* batchJobServiceClient.runBatchJobOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable
runBatchJobOperationCallable() {
return stub.runBatchJobOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Runs the batch job.
*
* The Operation.metadata field type is BatchJobMetadata. When finished, the long running
* operation will not contain errors or a response. Instead, use ListBatchJobResults to get the
* results of the job.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* RunBatchJobRequest request =
* RunBatchJobRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .build();
* ApiFuture future = batchJobServiceClient.runBatchJobCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable runBatchJobCallable() {
return stub.runBatchJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Add operations to the batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* BatchJobName resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]");
* List mutateOperations = new ArrayList<>();
* AddBatchJobOperationsResponse response =
* batchJobServiceClient.addBatchJobOperations(resourceName, mutateOperations);
* }
* }
*
* @param resourceName Required. The resource name of the batch job.
* @param mutateOperations Required. The list of mutates being added.
* Operations can use negative integers as temp ids to signify dependencies between
* entities created in this batch job. For example, a customer with id = 1234 can create a
* campaign and an ad group in that same campaign by creating a campaign in the first
* operation with the resource name explicitly set to "customers/1234/campaigns/-1", and
* creating an ad group in the second operation with the campaign field also set to
* "customers/1234/campaigns/-1".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AddBatchJobOperationsResponse addBatchJobOperations(
BatchJobName resourceName, List mutateOperations) {
AddBatchJobOperationsRequest request =
AddBatchJobOperationsRequest.newBuilder()
.setResourceName(resourceName == null ? null : resourceName.toString())
.addAllMutateOperations(mutateOperations)
.build();
return addBatchJobOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Add operations to the batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* String resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString();
* List mutateOperations = new ArrayList<>();
* AddBatchJobOperationsResponse response =
* batchJobServiceClient.addBatchJobOperations(resourceName, mutateOperations);
* }
* }
*
* @param resourceName Required. The resource name of the batch job.
* @param mutateOperations Required. The list of mutates being added.
* Operations can use negative integers as temp ids to signify dependencies between
* entities created in this batch job. For example, a customer with id = 1234 can create a
* campaign and an ad group in that same campaign by creating a campaign in the first
* operation with the resource name explicitly set to "customers/1234/campaigns/-1", and
* creating an ad group in the second operation with the campaign field also set to
* "customers/1234/campaigns/-1".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AddBatchJobOperationsResponse addBatchJobOperations(
String resourceName, List mutateOperations) {
AddBatchJobOperationsRequest request =
AddBatchJobOperationsRequest.newBuilder()
.setResourceName(resourceName)
.addAllMutateOperations(mutateOperations)
.build();
return addBatchJobOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Add operations to the batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* BatchJobName resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]");
* String sequenceToken = "sequenceToken-731053384";
* List mutateOperations = new ArrayList<>();
* AddBatchJobOperationsResponse response =
* batchJobServiceClient.addBatchJobOperations(
* resourceName, sequenceToken, mutateOperations);
* }
* }
*
* @param resourceName Required. The resource name of the batch job.
* @param sequenceToken A token used to enforce sequencing.
* The first AddBatchJobOperations request for a batch job should not set sequence_token.
* Subsequent requests must set sequence_token to the value of next_sequence_token received in
* the previous AddBatchJobOperations response.
* @param mutateOperations Required. The list of mutates being added.
*
Operations can use negative integers as temp ids to signify dependencies between
* entities created in this batch job. For example, a customer with id = 1234 can create a
* campaign and an ad group in that same campaign by creating a campaign in the first
* operation with the resource name explicitly set to "customers/1234/campaigns/-1", and
* creating an ad group in the second operation with the campaign field also set to
* "customers/1234/campaigns/-1".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AddBatchJobOperationsResponse addBatchJobOperations(
BatchJobName resourceName, String sequenceToken, List mutateOperations) {
AddBatchJobOperationsRequest request =
AddBatchJobOperationsRequest.newBuilder()
.setResourceName(resourceName == null ? null : resourceName.toString())
.setSequenceToken(sequenceToken)
.addAllMutateOperations(mutateOperations)
.build();
return addBatchJobOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Add operations to the batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* String resourceName = BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString();
* String sequenceToken = "sequenceToken-731053384";
* List mutateOperations = new ArrayList<>();
* AddBatchJobOperationsResponse response =
* batchJobServiceClient.addBatchJobOperations(
* resourceName, sequenceToken, mutateOperations);
* }
* }
*
* @param resourceName Required. The resource name of the batch job.
* @param sequenceToken A token used to enforce sequencing.
* The first AddBatchJobOperations request for a batch job should not set sequence_token.
* Subsequent requests must set sequence_token to the value of next_sequence_token received in
* the previous AddBatchJobOperations response.
* @param mutateOperations Required. The list of mutates being added.
*
Operations can use negative integers as temp ids to signify dependencies between
* entities created in this batch job. For example, a customer with id = 1234 can create a
* campaign and an ad group in that same campaign by creating a campaign in the first
* operation with the resource name explicitly set to "customers/1234/campaigns/-1", and
* creating an ad group in the second operation with the campaign field also set to
* "customers/1234/campaigns/-1".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AddBatchJobOperationsResponse addBatchJobOperations(
String resourceName, String sequenceToken, List mutateOperations) {
AddBatchJobOperationsRequest request =
AddBatchJobOperationsRequest.newBuilder()
.setResourceName(resourceName)
.setSequenceToken(sequenceToken)
.addAllMutateOperations(mutateOperations)
.build();
return addBatchJobOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Add operations to the batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* AddBatchJobOperationsRequest request =
* AddBatchJobOperationsRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .setSequenceToken("sequenceToken-731053384")
* .addAllMutateOperations(new ArrayList())
* .build();
* AddBatchJobOperationsResponse response = batchJobServiceClient.addBatchJobOperations(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 AddBatchJobOperationsResponse addBatchJobOperations(
AddBatchJobOperationsRequest request) {
return addBatchJobOperationsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Add operations to the batch job.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [BatchJobError]()
* [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* [ResourceCountLimitExceededError]()
*
*
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 (BatchJobServiceClient batchJobServiceClient = BatchJobServiceClient.create()) {
* AddBatchJobOperationsRequest request =
* AddBatchJobOperationsRequest.newBuilder()
* .setResourceName(BatchJobName.of("[CUSTOMER_ID]", "[BATCH_JOB_ID]").toString())
* .setSequenceToken("sequenceToken-731053384")
* .addAllMutateOperations(new ArrayList())
* .build();
* ApiFuture future =
* batchJobServiceClient.addBatchJobOperationsCallable().futureCall(request);
* // Do something.
* AddBatchJobOperationsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
addBatchJobOperationsCallable() {
return stub.addBatchJobOperationsCallable();
}
@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 ListBatchJobResultsPagedResponse
extends AbstractPagedListResponse<
ListBatchJobResultsRequest,
ListBatchJobResultsResponse,
BatchJobResult,
ListBatchJobResultsPage,
ListBatchJobResultsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListBatchJobResultsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListBatchJobResultsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListBatchJobResultsPagedResponse(ListBatchJobResultsPage page) {
super(page, ListBatchJobResultsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListBatchJobResultsPage
extends AbstractPage<
ListBatchJobResultsRequest,
ListBatchJobResultsResponse,
BatchJobResult,
ListBatchJobResultsPage> {
private ListBatchJobResultsPage(
PageContext
context,
ListBatchJobResultsResponse response) {
super(context, response);
}
private static ListBatchJobResultsPage createEmptyPage() {
return new ListBatchJobResultsPage(null, null);
}
@Override
protected ListBatchJobResultsPage createPage(
PageContext
context,
ListBatchJobResultsResponse response) {
return new ListBatchJobResultsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListBatchJobResultsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListBatchJobResultsRequest,
ListBatchJobResultsResponse,
BatchJobResult,
ListBatchJobResultsPage,
ListBatchJobResultsFixedSizeCollection> {
private ListBatchJobResultsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListBatchJobResultsFixedSizeCollection createEmptyCollection() {
return new ListBatchJobResultsFixedSizeCollection(null, 0);
}
@Override
protected ListBatchJobResultsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListBatchJobResultsFixedSizeCollection(pages, collectionSize);
}
}
}