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().

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.

Constructs an instance of TaxonomyCategoryServiceClient with default 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.

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

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.

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

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

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

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

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

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

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

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

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