Class TaxonomyCategoryServiceClient (0.11.0)

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:


 // 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:


 // 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:


 // 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.

Inheritance

java.lang.Object > TaxonomyCategoryServiceClient

Static Methods

create()

public static final TaxonomyCategoryServiceClient create()

Constructs an instance of TaxonomyCategoryServiceClient with default settings.

Returns
Type	Description
`TaxonomyCategoryServiceClient`

Exceptions
Type	Description
`IOException`

create(TaxonomyCategoryServiceSettings settings)

public static final TaxonomyCategoryServiceClient create(TaxonomyCategoryServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`TaxonomyCategoryServiceSettings`

Returns
Type	Description
`TaxonomyCategoryServiceClient`

Exceptions
Type	Description
`IOException`

create(TaxonomyCategoryServiceStub stub)

public static final TaxonomyCategoryServiceClient create(TaxonomyCategoryServiceStub stub)

Constructs an instance of TaxonomyCategoryServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TaxonomyCategoryServiceSettings).

Parameter
Name	Description
`stub`	`TaxonomyCategoryServiceStub`

Returns
Type	Description
`TaxonomyCategoryServiceClient`

Constructors

TaxonomyCategoryServiceClient(TaxonomyCategoryServiceSettings settings)

protected TaxonomyCategoryServiceClient(TaxonomyCategoryServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`TaxonomyCategoryServiceSettings`

TaxonomyCategoryServiceClient(TaxonomyCategoryServiceStub stub)

protected TaxonomyCategoryServiceClient(TaxonomyCategoryServiceStub stub)

Parameter
Name	Description
`stub`	`TaxonomyCategoryServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getSettings()

public final TaxonomyCategoryServiceSettings getSettings()

Returns
Type	Description
`TaxonomyCategoryServiceSettings`

getStub()

public TaxonomyCategoryServiceStub getStub()

Returns
Type	Description
`TaxonomyCategoryServiceStub`

getTaxonomyCategory(GetTaxonomyCategoryRequest request)

public final TaxonomyCategory getTaxonomyCategory(GetTaxonomyCategoryRequest request)

API to retrieve a TaxonomyCategory object.

Sample 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);
 }

Parameter
Name	Description
`request`	`GetTaxonomyCategoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TaxonomyCategory`

getTaxonomyCategory(TaxonomyCategoryName name)

public final TaxonomyCategory getTaxonomyCategory(TaxonomyCategoryName name)

API to retrieve a TaxonomyCategory object.

Sample 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);
 }

Parameter
Name	Description
`name`	`TaxonomyCategoryName` Required. The resource name of the TaxonomyCategory. Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`

Returns
Type	Description
`TaxonomyCategory`

getTaxonomyCategory(String name)

public final TaxonomyCategory getTaxonomyCategory(String name)

API to retrieve a TaxonomyCategory object.

Sample 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);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the TaxonomyCategory. Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`

Returns
Type	Description
`TaxonomyCategory`

getTaxonomyCategoryCallable()

public final UnaryCallable<GetTaxonomyCategoryRequest,TaxonomyCategory> getTaxonomyCategoryCallable()

API to retrieve a TaxonomyCategory object.

Sample 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<TaxonomyCategory> future =
       taxonomyCategoryServiceClient.getTaxonomyCategoryCallable().futureCall(request);
   // Do something.
   TaxonomyCategory response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetTaxonomyCategoryRequest,TaxonomyCategory>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listTaxonomyCategories(ListTaxonomyCategoriesRequest request)

public final TaxonomyCategoryServiceClient.ListTaxonomyCategoriesPagedResponse listTaxonomyCategories(ListTaxonomyCategoriesRequest request)

API to retrieve a list of TaxonomyCategory objects.

Sample 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);
   }
 }

Parameter
Name	Description
`request`	`ListTaxonomyCategoriesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TaxonomyCategoryServiceClient.ListTaxonomyCategoriesPagedResponse`

listTaxonomyCategories(NetworkName parent)

public final TaxonomyCategoryServiceClient.ListTaxonomyCategoriesPagedResponse listTaxonomyCategories(NetworkName parent)

API to retrieve a list of TaxonomyCategory objects.

Sample 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);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of TaxonomyCategories. Format: `networks/{network_code}`

Returns
Type	Description
`TaxonomyCategoryServiceClient.ListTaxonomyCategoriesPagedResponse`

listTaxonomyCategories(String parent)

public final TaxonomyCategoryServiceClient.ListTaxonomyCategoriesPagedResponse listTaxonomyCategories(String parent)

API to retrieve a list of TaxonomyCategory objects.

Sample 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);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of TaxonomyCategories. Format: `networks/{network_code}`

Returns
Type	Description
`TaxonomyCategoryServiceClient.ListTaxonomyCategoriesPagedResponse`

listTaxonomyCategoriesCallable()

public final UnaryCallable<ListTaxonomyCategoriesRequest,ListTaxonomyCategoriesResponse> listTaxonomyCategoriesCallable()

API to retrieve a list of TaxonomyCategory objects.

Sample 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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListTaxonomyCategoriesRequest,ListTaxonomyCategoriesResponse>`

listTaxonomyCategoriesPagedCallable()

public final UnaryCallable<ListTaxonomyCategoriesRequest,TaxonomyCategoryServiceClient.ListTaxonomyCategoriesPagedResponse> listTaxonomyCategoriesPagedCallable()

API to retrieve a list of TaxonomyCategory objects.

Sample 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<TaxonomyCategory> future =
       taxonomyCategoryServiceClient.listTaxonomyCategoriesPagedCallable().futureCall(request);
   // Do something.
   for (TaxonomyCategory element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListTaxonomyCategoriesRequest,ListTaxonomyCategoriesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()