Class LocalInventoryServiceClient (0.4.0)

public class LocalInventoryServiceClient implements BackgroundResource

Service Description: Service to manage local inventory for products

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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   InsertLocalInventoryRequest request =
       InsertLocalInventoryRequest.newBuilder()
           .setParent("parent-995424086")
           .setLocalInventory(LocalInventory.newBuilder().build())
           .build();
   LocalInventory response = localInventoryServiceClient.insertLocalInventory(request);
 }

Note: close() needs to be called on the LocalInventoryServiceClient 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 LocalInventoryServiceSettings 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
 LocalInventoryServiceSettings localInventoryServiceSettings =
     LocalInventoryServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create(localInventoryServiceSettings);

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
 LocalInventoryServiceSettings localInventoryServiceSettings =
     LocalInventoryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create(localInventoryServiceSettings);

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
 LocalInventoryServiceSettings localInventoryServiceSettings =
     LocalInventoryServiceSettings.newHttpJsonBuilder().build();
 LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create(localInventoryServiceSettings);

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

Inheritance

java.lang.Object > LocalInventoryServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final LocalInventoryServiceClient create()

Constructs an instance of LocalInventoryServiceClient with default settings.

Returns
Type	Description
`LocalInventoryServiceClient`

Exceptions
Type	Description
`IOException`

create(LocalInventoryServiceSettings settings)

public static final LocalInventoryServiceClient create(LocalInventoryServiceSettings settings)

Constructs an instance of LocalInventoryServiceClient, 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`	`LocalInventoryServiceSettings`

Returns
Type	Description
`LocalInventoryServiceClient`

Exceptions
Type	Description
`IOException`

create(LocalInventoryServiceStub stub)

public static final LocalInventoryServiceClient create(LocalInventoryServiceStub stub)

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

Parameter
Name	Description
`stub`	`LocalInventoryServiceStub`

Returns
Type	Description
`LocalInventoryServiceClient`

Constructors

LocalInventoryServiceClient(LocalInventoryServiceSettings settings)

protected LocalInventoryServiceClient(LocalInventoryServiceSettings settings)

Constructs an instance of LocalInventoryServiceClient, 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`	`LocalInventoryServiceSettings`

LocalInventoryServiceClient(LocalInventoryServiceStub stub)

protected LocalInventoryServiceClient(LocalInventoryServiceStub stub)

Parameter
Name	Description
`stub`	`LocalInventoryServiceStub`

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

deleteLocalInventory(DeleteLocalInventoryRequest request)

public final void deleteLocalInventory(DeleteLocalInventoryRequest request)

Deletes the specified LocalInventory from the given product in your merchant account. It might take a up to an hour for the LocalInventory 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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   DeleteLocalInventoryRequest request =
       DeleteLocalInventoryRequest.newBuilder()
           .setName(LocalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[STORE_CODE]").toString())
           .build();
   localInventoryServiceClient.deleteLocalInventory(request);
 }

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

deleteLocalInventory(LocalInventoryName name)

public final void deleteLocalInventory(LocalInventoryName name)

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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   LocalInventoryName name = LocalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[STORE_CODE]");
   localInventoryServiceClient.deleteLocalInventory(name);
 }

Parameter
Name	Description
`name`	`LocalInventoryName` Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}`

deleteLocalInventory(String name)

public final void deleteLocalInventory(String name)

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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   String name = LocalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[STORE_CODE]").toString();
   localInventoryServiceClient.deleteLocalInventory(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}`

deleteLocalInventoryCallable()

public final UnaryCallable<DeleteLocalInventoryRequest,Empty> deleteLocalInventoryCallable()

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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   DeleteLocalInventoryRequest request =
       DeleteLocalInventoryRequest.newBuilder()
           .setName(LocalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[STORE_CODE]").toString())
           .build();
   ApiFuture<Empty> future =
       localInventoryServiceClient.deleteLocalInventoryCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteLocalInventoryRequest,Empty>`

getSettings()

public final LocalInventoryServiceSettings getSettings()

Returns
Type	Description
`LocalInventoryServiceSettings`

getStub()

public LocalInventoryServiceStub getStub()

Returns
Type	Description
`LocalInventoryServiceStub`

insertLocalInventory(InsertLocalInventoryRequest request)

public final LocalInventory insertLocalInventory(InsertLocalInventoryRequest request)

Inserts a LocalInventory resource to a product in your merchant account.

Replaces the full LocalInventory resource if an entry with the same storeCode already exists for the product.

It might take up to 30 minutes for the new or updated LocalInventory 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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   InsertLocalInventoryRequest request =
       InsertLocalInventoryRequest.newBuilder()
           .setParent("parent-995424086")
           .setLocalInventory(LocalInventory.newBuilder().build())
           .build();
   LocalInventory response = localInventoryServiceClient.insertLocalInventory(request);
 }

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

Returns
Type	Description
`LocalInventory`

insertLocalInventoryCallable()

public final UnaryCallable<InsertLocalInventoryRequest,LocalInventory> insertLocalInventoryCallable()

Inserts a LocalInventory resource to a product in your merchant account.

Replaces the full LocalInventory resource if an entry with the same storeCode already exists for the product.

It might take up to 30 minutes for the new or updated LocalInventory 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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   InsertLocalInventoryRequest request =
       InsertLocalInventoryRequest.newBuilder()
           .setParent("parent-995424086")
           .setLocalInventory(LocalInventory.newBuilder().build())
           .build();
   ApiFuture<LocalInventory> future =
       localInventoryServiceClient.insertLocalInventoryCallable().futureCall(request);
   // Do something.
   LocalInventory response = future.get();
 }

Returns
Type	Description
`UnaryCallable<InsertLocalInventoryRequest,LocalInventory>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLocalInventories(ListLocalInventoriesRequest request)

public final LocalInventoryServiceClient.ListLocalInventoriesPagedResponse listLocalInventories(ListLocalInventoriesRequest request)

Lists the LocalInventory 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.

LocalInventory 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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   ListLocalInventoriesRequest request =
       ListLocalInventoriesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (LocalInventory element :
       localInventoryServiceClient.listLocalInventories(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`LocalInventoryServiceClient.ListLocalInventoriesPagedResponse`

listLocalInventories(String parent)

public final LocalInventoryServiceClient.ListLocalInventoriesPagedResponse listLocalInventories(String parent)

LocalInventory 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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   String parent = "parent-995424086";
   for (LocalInventory element :
       localInventoryServiceClient.listLocalInventories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}`

Returns
Type	Description
`LocalInventoryServiceClient.ListLocalInventoriesPagedResponse`

listLocalInventoriesCallable()

public final UnaryCallable<ListLocalInventoriesRequest,ListLocalInventoriesResponse> listLocalInventoriesCallable()

LocalInventory 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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   ListLocalInventoriesRequest request =
       ListLocalInventoriesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocalInventoriesResponse response =
         localInventoryServiceClient.listLocalInventoriesCallable().call(request);
     for (LocalInventory element : response.getLocalInventoriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListLocalInventoriesRequest,ListLocalInventoriesResponse>`

listLocalInventoriesPagedCallable()

public final UnaryCallable<ListLocalInventoriesRequest,LocalInventoryServiceClient.ListLocalInventoriesPagedResponse> listLocalInventoriesPagedCallable()

LocalInventory 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 (LocalInventoryServiceClient localInventoryServiceClient =
     LocalInventoryServiceClient.create()) {
   ListLocalInventoriesRequest request =
       ListLocalInventoriesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<LocalInventory> future =
       localInventoryServiceClient.listLocalInventoriesPagedCallable().futureCall(request);
   // Do something.
   for (LocalInventory element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListLocalInventoriesRequest,ListLocalInventoriesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()