com.google.ads.admanager.v1.TaxonomyCategoryServiceClient Maven / Gradle / Ivy
/*
* 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.admanager.v1;
import com.google.ads.admanager.v1.stub.TaxonomyCategoryServiceStub;
import com.google.ads.admanager.v1.stub.TaxonomyCategoryServiceStubSettings;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
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.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.common.util.concurrent.MoreExecutors;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Provides methods for handling `TaxonomyCategory` objects.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* TaxonomyCategoryName name = TaxonomyCategoryName.of("[NETWORK_CODE]", "[TAXONOMY_CATEGORY]");
* TaxonomyCategory response = taxonomyCategoryServiceClient.getTaxonomyCategory(name);
* }
* }
*
* Note: close() needs to be called on the TaxonomyCategoryServiceClient 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
*
*
* GetTaxonomyCategory
API to retrieve a `TaxonomyCategory` object.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getTaxonomyCategory(GetTaxonomyCategoryRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getTaxonomyCategory(TaxonomyCategoryName name)
*
getTaxonomyCategory(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.
*
* getTaxonomyCategoryCallable()
*
*
*
*
* ListTaxonomyCategories
API to retrieve a list of `TaxonomyCategory` objects.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listTaxonomyCategories(ListTaxonomyCategoriesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listTaxonomyCategories(NetworkName parent)
*
listTaxonomyCategories(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.
*
* listTaxonomyCategoriesPagedCallable()
*
listTaxonomyCategoriesCallable()
*
*
*
*
*
* 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
* TaxonomyCategoryServiceSettings 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
* TaxonomyCategoryServiceSettings taxonomyCategoryServiceSettings =
* TaxonomyCategoryServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create(taxonomyCategoryServiceSettings);
* }
*
* 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
* TaxonomyCategoryServiceSettings taxonomyCategoryServiceSettings =
* TaxonomyCategoryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create(taxonomyCategoryServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class TaxonomyCategoryServiceClient implements BackgroundResource {
private final TaxonomyCategoryServiceSettings settings;
private final TaxonomyCategoryServiceStub stub;
/** Constructs an instance of TaxonomyCategoryServiceClient with default settings. */
public static final TaxonomyCategoryServiceClient create() throws IOException {
return create(TaxonomyCategoryServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of TaxonomyCategoryServiceClient, 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 TaxonomyCategoryServiceClient create(TaxonomyCategoryServiceSettings settings)
throws IOException {
return new TaxonomyCategoryServiceClient(settings);
}
/**
* Constructs an instance of TaxonomyCategoryServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(TaxonomyCategoryServiceSettings).
*/
public static final TaxonomyCategoryServiceClient create(TaxonomyCategoryServiceStub stub) {
return new TaxonomyCategoryServiceClient(stub);
}
/**
* Constructs an instance of TaxonomyCategoryServiceClient, 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 TaxonomyCategoryServiceClient(TaxonomyCategoryServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((TaxonomyCategoryServiceStubSettings) settings.getStubSettings()).createStub();
}
protected TaxonomyCategoryServiceClient(TaxonomyCategoryServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final TaxonomyCategoryServiceSettings getSettings() {
return settings;
}
public TaxonomyCategoryServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a `TaxonomyCategory` object.
*
*
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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* TaxonomyCategoryName name = TaxonomyCategoryName.of("[NETWORK_CODE]", "[TAXONOMY_CATEGORY]");
* TaxonomyCategory response = taxonomyCategoryServiceClient.getTaxonomyCategory(name);
* }
* }
*
* @param name Required. The resource name of the TaxonomyCategory. Format:
* `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TaxonomyCategory getTaxonomyCategory(TaxonomyCategoryName name) {
GetTaxonomyCategoryRequest request =
GetTaxonomyCategoryRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getTaxonomyCategory(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a `TaxonomyCategory` object.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* String name = TaxonomyCategoryName.of("[NETWORK_CODE]", "[TAXONOMY_CATEGORY]").toString();
* TaxonomyCategory response = taxonomyCategoryServiceClient.getTaxonomyCategory(name);
* }
* }
*
* @param name Required. The resource name of the TaxonomyCategory. Format:
* `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TaxonomyCategory getTaxonomyCategory(String name) {
GetTaxonomyCategoryRequest request =
GetTaxonomyCategoryRequest.newBuilder().setName(name).build();
return getTaxonomyCategory(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a `TaxonomyCategory` object.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* GetTaxonomyCategoryRequest request =
* GetTaxonomyCategoryRequest.newBuilder()
* .setName(TaxonomyCategoryName.of("[NETWORK_CODE]", "[TAXONOMY_CATEGORY]").toString())
* .build();
* TaxonomyCategory response = taxonomyCategoryServiceClient.getTaxonomyCategory(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 TaxonomyCategory getTaxonomyCategory(GetTaxonomyCategoryRequest request) {
return getTaxonomyCategoryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a `TaxonomyCategory` object.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* GetTaxonomyCategoryRequest request =
* GetTaxonomyCategoryRequest.newBuilder()
* .setName(TaxonomyCategoryName.of("[NETWORK_CODE]", "[TAXONOMY_CATEGORY]").toString())
* .build();
* ApiFuture future =
* taxonomyCategoryServiceClient.getTaxonomyCategoryCallable().futureCall(request);
* // Do something.
* TaxonomyCategory response = future.get();
* }
* }
*/
public final UnaryCallable
getTaxonomyCategoryCallable() {
return stub.getTaxonomyCategoryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a list of `TaxonomyCategory` objects.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* NetworkName parent = NetworkName.of("[NETWORK_CODE]");
* for (TaxonomyCategory element :
* taxonomyCategoryServiceClient.listTaxonomyCategories(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of TaxonomyCategories. Format:
* `networks/{network_code}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTaxonomyCategoriesPagedResponse listTaxonomyCategories(NetworkName parent) {
ListTaxonomyCategoriesRequest request =
ListTaxonomyCategoriesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTaxonomyCategories(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a list of `TaxonomyCategory` objects.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* String parent = NetworkName.of("[NETWORK_CODE]").toString();
* for (TaxonomyCategory element :
* taxonomyCategoryServiceClient.listTaxonomyCategories(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of TaxonomyCategories. Format:
* `networks/{network_code}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTaxonomyCategoriesPagedResponse listTaxonomyCategories(String parent) {
ListTaxonomyCategoriesRequest request =
ListTaxonomyCategoriesRequest.newBuilder().setParent(parent).build();
return listTaxonomyCategories(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a list of `TaxonomyCategory` objects.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* ListTaxonomyCategoriesRequest request =
* ListTaxonomyCategoriesRequest.newBuilder()
* .setParent(NetworkName.of("[NETWORK_CODE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setSkip(3532159)
* .build();
* for (TaxonomyCategory element :
* taxonomyCategoryServiceClient.listTaxonomyCategories(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 ListTaxonomyCategoriesPagedResponse listTaxonomyCategories(
ListTaxonomyCategoriesRequest request) {
return listTaxonomyCategoriesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a list of `TaxonomyCategory` objects.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* ListTaxonomyCategoriesRequest request =
* ListTaxonomyCategoriesRequest.newBuilder()
* .setParent(NetworkName.of("[NETWORK_CODE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setSkip(3532159)
* .build();
* ApiFuture future =
* taxonomyCategoryServiceClient.listTaxonomyCategoriesPagedCallable().futureCall(request);
* // Do something.
* for (TaxonomyCategory element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listTaxonomyCategoriesPagedCallable() {
return stub.listTaxonomyCategoriesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* API to retrieve a list of `TaxonomyCategory` objects.
*
* 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 (TaxonomyCategoryServiceClient taxonomyCategoryServiceClient =
* TaxonomyCategoryServiceClient.create()) {
* ListTaxonomyCategoriesRequest request =
* ListTaxonomyCategoriesRequest.newBuilder()
* .setParent(NetworkName.of("[NETWORK_CODE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setOrderBy("orderBy-1207110587")
* .setSkip(3532159)
* .build();
* while (true) {
* ListTaxonomyCategoriesResponse response =
* taxonomyCategoryServiceClient.listTaxonomyCategoriesCallable().call(request);
* for (TaxonomyCategory element : response.getTaxonomyCategoriesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listTaxonomyCategoriesCallable() {
return stub.listTaxonomyCategoriesCallable();
}
@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 ListTaxonomyCategoriesPagedResponse
extends AbstractPagedListResponse<
ListTaxonomyCategoriesRequest,
ListTaxonomyCategoriesResponse,
TaxonomyCategory,
ListTaxonomyCategoriesPage,
ListTaxonomyCategoriesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTaxonomyCategoriesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListTaxonomyCategoriesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListTaxonomyCategoriesPagedResponse(ListTaxonomyCategoriesPage page) {
super(page, ListTaxonomyCategoriesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTaxonomyCategoriesPage
extends AbstractPage<
ListTaxonomyCategoriesRequest,
ListTaxonomyCategoriesResponse,
TaxonomyCategory,
ListTaxonomyCategoriesPage> {
private ListTaxonomyCategoriesPage(
PageContext
context,
ListTaxonomyCategoriesResponse response) {
super(context, response);
}
private static ListTaxonomyCategoriesPage createEmptyPage() {
return new ListTaxonomyCategoriesPage(null, null);
}
@Override
protected ListTaxonomyCategoriesPage createPage(
PageContext
context,
ListTaxonomyCategoriesResponse response) {
return new ListTaxonomyCategoriesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTaxonomyCategoriesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListTaxonomyCategoriesRequest,
ListTaxonomyCategoriesResponse,
TaxonomyCategory,
ListTaxonomyCategoriesPage,
ListTaxonomyCategoriesFixedSizeCollection> {
private ListTaxonomyCategoriesFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTaxonomyCategoriesFixedSizeCollection createEmptyCollection() {
return new ListTaxonomyCategoriesFixedSizeCollection(null, 0);
}
@Override
protected ListTaxonomyCategoriesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTaxonomyCategoriesFixedSizeCollection(pages, collectionSize);
}
}
}