Class RegionalInventoryServiceClient (0.21.0)

Service Description: Service to manage regional inventory for products. There is also separate regions resource and API to manage regions definitions.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   InsertRegionalInventoryRequest request =
       InsertRegionalInventoryRequest.newBuilder()
           .setParent(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .setRegionalInventory(RegionalInventory.newBuilder().build())
           .build();
   RegionalInventory response = regionalInventoryServiceClient.insertRegionalInventory(request);
 }
 

Note: close() needs to be called on the RegionalInventoryServiceClient 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 RegionalInventoryServiceSettings 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
 RegionalInventoryServiceSettings regionalInventoryServiceSettings =
     RegionalInventoryServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create(regionalInventoryServiceSettings);
 

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
 RegionalInventoryServiceSettings regionalInventoryServiceSettings =
     RegionalInventoryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create(regionalInventoryServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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
 RegionalInventoryServiceSettings regionalInventoryServiceSettings =
     RegionalInventoryServiceSettings.newHttpJsonBuilder().build();
 RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create(regionalInventoryServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Constructs an instance of RegionalInventoryServiceClient with default settings.

Constructs an instance of RegionalInventoryServiceClient, 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 RegionalInventoryServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionalInventoryServiceSettings).

Constructs an instance of RegionalInventoryServiceClient, 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.

Deletes the specified RegionalInventory resource from the given product in your merchant account. It might take up to an hour for the RegionalInventory to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   DeleteRegionalInventoryRequest request =
       DeleteRegionalInventoryRequest.newBuilder()
           .setName(RegionalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[REGION]").toString())
           .build();
   regionalInventoryServiceClient.deleteRegionalInventory(request);
 }
 

Deletes the specified RegionalInventory resource from the given product in your merchant account. It might take up to an hour for the RegionalInventory to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   RegionalInventoryName name = RegionalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[REGION]");
   regionalInventoryServiceClient.deleteRegionalInventory(name);
 }
 

Deletes the specified RegionalInventory resource from the given product in your merchant account. It might take up to an hour for the RegionalInventory to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   String name = RegionalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[REGION]").toString();
   regionalInventoryServiceClient.deleteRegionalInventory(name);
 }
 

Deletes the specified RegionalInventory resource from the given product in your merchant account. It might take up to an hour for the RegionalInventory to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   DeleteRegionalInventoryRequest request =
       DeleteRegionalInventoryRequest.newBuilder()
           .setName(RegionalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[REGION]").toString())
           .build();
   ApiFuture<Empty> future =
       regionalInventoryServiceClient.deleteRegionalInventoryCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Inserts a RegionalInventory to a given product in your merchant account.

Replaces the full RegionalInventory resource if an entry with the same region already exists for the product.

It might take up to 30 minutes for the new or updated RegionalInventory resource to appear in products.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   InsertRegionalInventoryRequest request =
       InsertRegionalInventoryRequest.newBuilder()
           .setParent(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .setRegionalInventory(RegionalInventory.newBuilder().build())
           .build();
   RegionalInventory response = regionalInventoryServiceClient.insertRegionalInventory(request);
 }
 

Inserts a RegionalInventory to a given product in your merchant account.

Replaces the full RegionalInventory resource if an entry with the same region already exists for the product.

It might take up to 30 minutes for the new or updated RegionalInventory resource to appear in products.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   InsertRegionalInventoryRequest request =
       InsertRegionalInventoryRequest.newBuilder()
           .setParent(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .setRegionalInventory(RegionalInventory.newBuilder().build())
           .build();
   ApiFuture<RegionalInventory> future =
       regionalInventoryServiceClient.insertRegionalInventoryCallable().futureCall(request);
   // Do something.
   RegionalInventory response = future.get();
 }
 

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   ListRegionalInventoriesRequest request =
       ListRegionalInventoriesRequest.newBuilder()
           .setParent(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RegionalInventory element :
       regionalInventoryServiceClient.listRegionalInventories(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   ProductName parent = ProductName.of("[ACCOUNT]", "[PRODUCT]");
   for (RegionalInventory element :
       regionalInventoryServiceClient.listRegionalInventories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   String parent = ProductName.of("[ACCOUNT]", "[PRODUCT]").toString();
   for (RegionalInventory element :
       regionalInventoryServiceClient.listRegionalInventories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   ListRegionalInventoriesRequest request =
       ListRegionalInventoriesRequest.newBuilder()
           .setParent(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRegionalInventoriesResponse response =
         regionalInventoryServiceClient.listRegionalInventoriesCallable().call(request);
     for (RegionalInventory element : response.getRegionalInventoriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

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 (RegionalInventoryServiceClient regionalInventoryServiceClient =
     RegionalInventoryServiceClient.create()) {
   ListRegionalInventoriesRequest request =
       ListRegionalInventoriesRequest.newBuilder()
           .setParent(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RegionalInventory> future =
       regionalInventoryServiceClient.listRegionalInventoriesPagedCallable().futureCall(request);
   // Do something.
   for (RegionalInventory element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }