All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.ads.googleads.v17.services.CustomerAssetSetServiceClient Maven / Gradle / Ivy

The newest version!
/*
 * 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.services.stub.CustomerAssetSetServiceStub;
import com.google.ads.googleads.v17.services.stub.CustomerAssetSetServiceStubSettings;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
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 customer asset set
 *
 * 

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 (CustomerAssetSetServiceClient customerAssetSetServiceClient =
 *     CustomerAssetSetServiceClient.create()) {
 *   String customerId = "customerId-1581184615";
 *   List operations = new ArrayList<>();
 *   MutateCustomerAssetSetsResponse response =
 *       customerAssetSetServiceClient.mutateCustomerAssetSets(customerId, operations);
 * }
 * }
* *

Note: close() needs to be called on the CustomerAssetSetServiceClient object to clean up * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). * *

* * * * * * * * * * * *
Methods
MethodDescriptionMethod Variants

MutateCustomerAssetSets

Creates, or removes customer asset sets. Operation statuses are returned.

*

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    *
  • mutateCustomerAssetSets(MutateCustomerAssetSetsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    *
  • mutateCustomerAssetSets(String customerId, List<CustomerAssetSetOperation> operations) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    *
  • mutateCustomerAssetSetsCallable() *

*
* *

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 * CustomerAssetSetServiceSettings 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
 * CustomerAssetSetServiceSettings customerAssetSetServiceSettings =
 *     CustomerAssetSetServiceSettings.newBuilder()
 *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
 *         .build();
 * CustomerAssetSetServiceClient customerAssetSetServiceClient =
 *     CustomerAssetSetServiceClient.create(customerAssetSetServiceSettings);
 * }
* *

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
 * CustomerAssetSetServiceSettings customerAssetSetServiceSettings =
 *     CustomerAssetSetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 * CustomerAssetSetServiceClient customerAssetSetServiceClient =
 *     CustomerAssetSetServiceClient.create(customerAssetSetServiceSettings);
 * }
* *

Please refer to the GitHub repository's samples for more quickstart code snippets. */ @Generated("by gapic-generator-java") public class CustomerAssetSetServiceClient implements BackgroundResource { private final CustomerAssetSetServiceSettings settings; private final CustomerAssetSetServiceStub stub; /** Constructs an instance of CustomerAssetSetServiceClient with default settings. */ public static final CustomerAssetSetServiceClient create() throws IOException { return create(CustomerAssetSetServiceSettings.newBuilder().build()); } /** * Constructs an instance of CustomerAssetSetServiceClient, 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 CustomerAssetSetServiceClient create(CustomerAssetSetServiceSettings settings) throws IOException { return new CustomerAssetSetServiceClient(settings); } /** * Constructs an instance of CustomerAssetSetServiceClient, using the given stub for making calls. * This is for advanced usage - prefer using create(CustomerAssetSetServiceSettings). */ public static final CustomerAssetSetServiceClient create(CustomerAssetSetServiceStub stub) { return new CustomerAssetSetServiceClient(stub); } /** * Constructs an instance of CustomerAssetSetServiceClient, 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 CustomerAssetSetServiceClient(CustomerAssetSetServiceSettings settings) throws IOException { this.settings = settings; this.stub = ((CustomerAssetSetServiceStubSettings) settings.getStubSettings()).createStub(); } protected CustomerAssetSetServiceClient(CustomerAssetSetServiceStub stub) { this.settings = null; this.stub = stub; } public final CustomerAssetSetServiceSettings getSettings() { return settings; } public CustomerAssetSetServiceStub getStub() { return stub; } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates, or removes customer asset sets. Operation statuses are returned. * *

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 (CustomerAssetSetServiceClient customerAssetSetServiceClient =
   *     CustomerAssetSetServiceClient.create()) {
   *   String customerId = "customerId-1581184615";
   *   List operations = new ArrayList<>();
   *   MutateCustomerAssetSetsResponse response =
   *       customerAssetSetServiceClient.mutateCustomerAssetSets(customerId, operations);
   * }
   * }
* * @param customerId Required. The ID of the customer whose customer asset sets are being * modified. * @param operations Required. The list of operations to perform on individual customer asset * sets. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ public final MutateCustomerAssetSetsResponse mutateCustomerAssetSets( String customerId, List operations) { MutateCustomerAssetSetsRequest request = MutateCustomerAssetSetsRequest.newBuilder() .setCustomerId(customerId) .addAllOperations(operations) .build(); return mutateCustomerAssetSets(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates, or removes customer asset sets. Operation statuses are returned. * *

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 (CustomerAssetSetServiceClient customerAssetSetServiceClient =
   *     CustomerAssetSetServiceClient.create()) {
   *   MutateCustomerAssetSetsRequest request =
   *       MutateCustomerAssetSetsRequest.newBuilder()
   *           .setCustomerId("customerId-1581184615")
   *           .addAllOperations(new ArrayList())
   *           .setPartialFailure(true)
   *           .setValidateOnly(true)
   *           .build();
   *   MutateCustomerAssetSetsResponse response =
   *       customerAssetSetServiceClient.mutateCustomerAssetSets(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 MutateCustomerAssetSetsResponse mutateCustomerAssetSets( MutateCustomerAssetSetsRequest request) { return mutateCustomerAssetSetsCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates, or removes customer asset sets. Operation statuses are returned. * *

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 (CustomerAssetSetServiceClient customerAssetSetServiceClient =
   *     CustomerAssetSetServiceClient.create()) {
   *   MutateCustomerAssetSetsRequest request =
   *       MutateCustomerAssetSetsRequest.newBuilder()
   *           .setCustomerId("customerId-1581184615")
   *           .addAllOperations(new ArrayList())
   *           .setPartialFailure(true)
   *           .setValidateOnly(true)
   *           .build();
   *   ApiFuture future =
   *       customerAssetSetServiceClient.mutateCustomerAssetSetsCallable().futureCall(request);
   *   // Do something.
   *   MutateCustomerAssetSetsResponse response = future.get();
   * }
   * }
*/ public final UnaryCallable mutateCustomerAssetSetsCallable() { return stub.mutateCustomerAssetSetsCallable(); } @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); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy