com.google.ads.googleads.v9.services.BiddingDataExclusionServiceClient Maven / Gradle / Ivy
Show all versions of google-ads-stubs-v9 Show documentation
/*
* Copyright 2021 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.v9.services;
import com.google.ads.googleads.v9.resources.BiddingDataExclusion;
import com.google.ads.googleads.v9.resources.BiddingDataExclusionName;
import com.google.ads.googleads.v9.services.stub.BiddingDataExclusionServiceStub;
import com.google.ads.googleads.v9.services.stub.BiddingDataExclusionServiceStubSettings;
import com.google.api.core.BetaApi;
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 bidding data exclusions.
*
* 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
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* BiddingDataExclusionName resourceName =
* BiddingDataExclusionName.of("[CUSTOMER_ID]", "[SEASONALITY_EVENT_ID]");
* BiddingDataExclusion response =
* biddingDataExclusionServiceClient.getBiddingDataExclusion(resourceName);
* }
* }
*
* Note: close() needs to be called on the BiddingDataExclusionServiceClient object to clean up
* resources such as threads. In the example above, try-with-resources is used, which automatically
* calls close().
*
*
The surface of this class includes several types of Java methods for each of the API's
* methods:
*
*
* - A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
*
- A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
*
- A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
*
*
* 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
* BiddingDataExclusionServiceSettings to create(). For example:
*
*
To customize credentials:
*
*
{@code
* BiddingDataExclusionServiceSettings biddingDataExclusionServiceSettings =
* BiddingDataExclusionServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create(biddingDataExclusionServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* BiddingDataExclusionServiceSettings biddingDataExclusionServiceSettings =
* BiddingDataExclusionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create(biddingDataExclusionServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class BiddingDataExclusionServiceClient implements BackgroundResource {
private final BiddingDataExclusionServiceSettings settings;
private final BiddingDataExclusionServiceStub stub;
/** Constructs an instance of BiddingDataExclusionServiceClient with default settings. */
public static final BiddingDataExclusionServiceClient create() throws IOException {
return create(BiddingDataExclusionServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of BiddingDataExclusionServiceClient, 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 BiddingDataExclusionServiceClient create(
BiddingDataExclusionServiceSettings settings) throws IOException {
return new BiddingDataExclusionServiceClient(settings);
}
/**
* Constructs an instance of BiddingDataExclusionServiceClient, using the given stub for making
* calls. This is for advanced usage - prefer using create(BiddingDataExclusionServiceSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final BiddingDataExclusionServiceClient create(
BiddingDataExclusionServiceStub stub) {
return new BiddingDataExclusionServiceClient(stub);
}
/**
* Constructs an instance of BiddingDataExclusionServiceClient, 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 BiddingDataExclusionServiceClient(BiddingDataExclusionServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((BiddingDataExclusionServiceStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected BiddingDataExclusionServiceClient(BiddingDataExclusionServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final BiddingDataExclusionServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public BiddingDataExclusionServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested data exclusion in full detail.
*
*
Sample code:
*
*
{@code
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* BiddingDataExclusionName resourceName =
* BiddingDataExclusionName.of("[CUSTOMER_ID]", "[SEASONALITY_EVENT_ID]");
* BiddingDataExclusion response =
* biddingDataExclusionServiceClient.getBiddingDataExclusion(resourceName);
* }
* }
*
* @param resourceName Required. The resource name of the data exclusion to fetch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BiddingDataExclusion getBiddingDataExclusion(BiddingDataExclusionName resourceName) {
GetBiddingDataExclusionRequest request =
GetBiddingDataExclusionRequest.newBuilder()
.setResourceName(resourceName == null ? null : resourceName.toString())
.build();
return getBiddingDataExclusion(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested data exclusion in full detail.
*
* Sample code:
*
*
{@code
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* String resourceName =
* BiddingDataExclusionName.of("[CUSTOMER_ID]", "[SEASONALITY_EVENT_ID]").toString();
* BiddingDataExclusion response =
* biddingDataExclusionServiceClient.getBiddingDataExclusion(resourceName);
* }
* }
*
* @param resourceName Required. The resource name of the data exclusion to fetch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BiddingDataExclusion getBiddingDataExclusion(String resourceName) {
GetBiddingDataExclusionRequest request =
GetBiddingDataExclusionRequest.newBuilder().setResourceName(resourceName).build();
return getBiddingDataExclusion(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested data exclusion in full detail.
*
* Sample code:
*
*
{@code
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* GetBiddingDataExclusionRequest request =
* GetBiddingDataExclusionRequest.newBuilder()
* .setResourceName(
* BiddingDataExclusionName.of("[CUSTOMER_ID]", "[SEASONALITY_EVENT_ID]").toString())
* .build();
* BiddingDataExclusion response =
* biddingDataExclusionServiceClient.getBiddingDataExclusion(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 BiddingDataExclusion getBiddingDataExclusion(
GetBiddingDataExclusionRequest request) {
return getBiddingDataExclusionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested data exclusion in full detail.
*
* Sample code:
*
*
{@code
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* GetBiddingDataExclusionRequest request =
* GetBiddingDataExclusionRequest.newBuilder()
* .setResourceName(
* BiddingDataExclusionName.of("[CUSTOMER_ID]", "[SEASONALITY_EVENT_ID]").toString())
* .build();
* ApiFuture future =
* biddingDataExclusionServiceClient.getBiddingDataExclusionCallable().futureCall(request);
* // Do something.
* BiddingDataExclusion response = future.get();
* }
* }
*/
public final UnaryCallable
getBiddingDataExclusionCallable() {
return stub.getBiddingDataExclusionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes data exclusions. Operation statuses are returned.
*
* Sample code:
*
*
{@code
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* String customerId = "customerId-1581184615";
* List operations = new ArrayList<>();
* MutateBiddingDataExclusionsResponse response =
* biddingDataExclusionServiceClient.mutateBiddingDataExclusions(customerId, operations);
* }
* }
*
* @param customerId Required. ID of the customer whose data exclusions are being modified.
* @param operations Required. The list of operations to perform on individual data exclusions.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final MutateBiddingDataExclusionsResponse mutateBiddingDataExclusions(
String customerId, List operations) {
MutateBiddingDataExclusionsRequest request =
MutateBiddingDataExclusionsRequest.newBuilder()
.setCustomerId(customerId)
.addAllOperations(operations)
.build();
return mutateBiddingDataExclusions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes data exclusions. Operation statuses are returned.
*
* Sample code:
*
*
{@code
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* MutateBiddingDataExclusionsRequest request =
* MutateBiddingDataExclusionsRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .addAllOperations(new ArrayList())
* .setPartialFailure(true)
* .setValidateOnly(true)
* .build();
* MutateBiddingDataExclusionsResponse response =
* biddingDataExclusionServiceClient.mutateBiddingDataExclusions(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 MutateBiddingDataExclusionsResponse mutateBiddingDataExclusions(
MutateBiddingDataExclusionsRequest request) {
return mutateBiddingDataExclusionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes data exclusions. Operation statuses are returned.
*
* Sample code:
*
*
{@code
* try (BiddingDataExclusionServiceClient biddingDataExclusionServiceClient =
* BiddingDataExclusionServiceClient.create()) {
* MutateBiddingDataExclusionsRequest request =
* MutateBiddingDataExclusionsRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .addAllOperations(new ArrayList())
* .setPartialFailure(true)
* .setValidateOnly(true)
* .build();
* ApiFuture future =
* biddingDataExclusionServiceClient
* .mutateBiddingDataExclusionsCallable()
* .futureCall(request);
* // Do something.
* MutateBiddingDataExclusionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable<
MutateBiddingDataExclusionsRequest, MutateBiddingDataExclusionsResponse>
mutateBiddingDataExclusionsCallable() {
return stub.mutateBiddingDataExclusionsCallable();
}
@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);
}
}