| GitHub Repository | Product Reference |
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("parent-995424086")
.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().
| Method | Description | Method Variants |
|---|---|---|
| ListRegionalInventories | Lists the |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| InsertRegionalInventory | Inserts a Replaces the full It might take up to 30 minutes for the new or updated |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
| DeleteRegionalInventory | Deletes the specified |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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 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.
Static Methods
create()
public static final RegionalInventoryServiceClient create()Constructs an instance of RegionalInventoryServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
RegionalInventoryServiceClient | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
create(RegionalInventoryServiceSettings settings)
public static final RegionalInventoryServiceClient create(RegionalInventoryServiceSettings 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.
| Parameter | |
|---|---|
| Name | Description |
settings | RegionalInventoryServiceSettings |
| Returns | |
|---|---|
| Type | Description |
RegionalInventoryServiceClient | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
create(RegionalInventoryServiceStub stub)
public static final RegionalInventoryServiceClient create(RegionalInventoryServiceStub stub)Constructs an instance of RegionalInventoryServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionalInventoryServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub | RegionalInventoryServiceStub |
| Returns | |
|---|---|
| Type | Description |
RegionalInventoryServiceClient | |
Constructors
RegionalInventoryServiceClient(RegionalInventoryServiceSettings settings)
protected RegionalInventoryServiceClient(RegionalInventoryServiceSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings | RegionalInventoryServiceSettings |
RegionalInventoryServiceClient(RegionalInventoryServiceStub stub)
protected RegionalInventoryServiceClient(RegionalInventoryServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub | RegionalInventoryServiceStub |
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()deleteRegionalInventory(DeleteRegionalInventoryRequest request)
public final void deleteRegionalInventory(DeleteRegionalInventoryRequest 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()) {
DeleteRegionalInventoryRequest request =
DeleteRegionalInventoryRequest.newBuilder()
.setName(RegionalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[REGION]").toString())
.build();
regionalInventoryServiceClient.deleteRegionalInventory(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | DeleteRegionalInventoryRequestThe request object containing all of the parameters for the API call. |
deleteRegionalInventory(RegionalInventoryName name)
public final void deleteRegionalInventory(RegionalInventoryName 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()) {
RegionalInventoryName name = RegionalInventoryName.of("[ACCOUNT]", "[PRODUCT]", "[REGION]");
regionalInventoryServiceClient.deleteRegionalInventory(name);
}
| Parameter | |
|---|---|
| Name | Description |
name | RegionalInventoryNameRequired. The name of the |
deleteRegionalInventory(String name)
public final void deleteRegionalInventory(String 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);
}
| Parameter | |
|---|---|
| Name | Description |
name | StringRequired. The name of the |
deleteRegionalInventoryCallable()
public final UnaryCallable<DeleteRegionalInventoryRequest,Empty> deleteRegionalInventoryCallable()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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteRegionalInventoryRequest,Empty> | |
getSettings()
public final RegionalInventoryServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
RegionalInventoryServiceSettings | |
getStub()
public RegionalInventoryServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
RegionalInventoryServiceStub | |
insertRegionalInventory(InsertRegionalInventoryRequest request)
public final RegionalInventory insertRegionalInventory(InsertRegionalInventoryRequest 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("parent-995424086")
.setRegionalInventory(RegionalInventory.newBuilder().build())
.build();
RegionalInventory response = regionalInventoryServiceClient.insertRegionalInventory(request);
}
| Parameter | |
|---|---|
| Name | Description |
request | InsertRegionalInventoryRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
RegionalInventory | |
insertRegionalInventoryCallable()
public final UnaryCallable<InsertRegionalInventoryRequest,RegionalInventory> insertRegionalInventoryCallable()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("parent-995424086")
.setRegionalInventory(RegionalInventory.newBuilder().build())
.build();
ApiFuture<RegionalInventory> future =
regionalInventoryServiceClient.insertRegionalInventoryCallable().futureCall(request);
// Do something.
RegionalInventory response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<InsertRegionalInventoryRequest,RegionalInventory> | |
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean | |
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean | |
listRegionalInventories(ListRegionalInventoriesRequest request)
public final RegionalInventoryServiceClient.ListRegionalInventoriesPagedResponse listRegionalInventories(ListRegionalInventoriesRequest request)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("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (RegionalInventory element :
regionalInventoryServiceClient.listRegionalInventories(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request | ListRegionalInventoriesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
RegionalInventoryServiceClient.ListRegionalInventoriesPagedResponse | |
listRegionalInventories(String parent)
public final RegionalInventoryServiceClient.ListRegionalInventoriesPagedResponse listRegionalInventories(String parent)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 = "parent-995424086";
for (RegionalInventory element :
regionalInventoryServiceClient.listRegionalInventories(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent | StringRequired. The |
| Returns | |
|---|---|
| Type | Description |
RegionalInventoryServiceClient.ListRegionalInventoriesPagedResponse | |
listRegionalInventoriesCallable()
public final UnaryCallable<ListRegionalInventoriesRequest,ListRegionalInventoriesResponse> listRegionalInventoriesCallable()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("parent-995424086")
.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;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListRegionalInventoriesRequest,ListRegionalInventoriesResponse> | |
listRegionalInventoriesPagedCallable()
public final UnaryCallable<ListRegionalInventoriesRequest,RegionalInventoryServiceClient.ListRegionalInventoriesPagedResponse> listRegionalInventoriesPagedCallable()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("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<RegionalInventory> future =
regionalInventoryServiceClient.listRegionalInventoriesPagedCallable().futureCall(request);
// Do something.
for (RegionalInventory element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListRegionalInventoriesRequest,ListRegionalInventoriesPagedResponse> | |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()