| GitHub Repository | Product Reference |
Service Description: Service for a LFP partner to submit local inventories for a merchant.
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 (LfpInventoryServiceClient lfpInventoryServiceClient = LfpInventoryServiceClient.create()) {
InsertLfpInventoryRequest request =
InsertLfpInventoryRequest.newBuilder()
.setParent(AccountName.of("[ACCOUNT]").toString())
.setLfpInventory(LfpInventory.newBuilder().build())
.build();
LfpInventory response = lfpInventoryServiceClient.insertLfpInventory(request);
}
Note: close() needs to be called on the LfpInventoryServiceClient 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 |
|---|---|---|
InsertLfpInventory |
Inserts a |
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.
|
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 LfpInventoryServiceSettings 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
LfpInventoryServiceSettings lfpInventoryServiceSettings =
LfpInventoryServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
LfpInventoryServiceClient lfpInventoryServiceClient =
LfpInventoryServiceClient.create(lfpInventoryServiceSettings);
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
LfpInventoryServiceSettings lfpInventoryServiceSettings =
LfpInventoryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
LfpInventoryServiceClient lfpInventoryServiceClient =
LfpInventoryServiceClient.create(lfpInventoryServiceSettings);
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
LfpInventoryServiceSettings lfpInventoryServiceSettings =
LfpInventoryServiceSettings.newHttpJsonBuilder().build();
LfpInventoryServiceClient lfpInventoryServiceClient =
LfpInventoryServiceClient.create(lfpInventoryServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final LfpInventoryServiceClient create()Constructs an instance of LfpInventoryServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
LfpInventoryServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(LfpInventoryServiceSettings settings)
public static final LfpInventoryServiceClient create(LfpInventoryServiceSettings settings)Constructs an instance of LfpInventoryServiceClient, 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 |
LfpInventoryServiceSettings |
| Returns | |
|---|---|
| Type | Description |
LfpInventoryServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(LfpInventoryServiceStub stub)
public static final LfpInventoryServiceClient create(LfpInventoryServiceStub stub)Constructs an instance of LfpInventoryServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(LfpInventoryServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
LfpInventoryServiceStub |
| Returns | |
|---|---|
| Type | Description |
LfpInventoryServiceClient |
|
Constructors
LfpInventoryServiceClient(LfpInventoryServiceSettings settings)
protected LfpInventoryServiceClient(LfpInventoryServiceSettings settings)Constructs an instance of LfpInventoryServiceClient, 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 |
LfpInventoryServiceSettings |
LfpInventoryServiceClient(LfpInventoryServiceStub stub)
protected LfpInventoryServiceClient(LfpInventoryServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
LfpInventoryServiceStub |
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 LfpInventoryServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
LfpInventoryServiceSettings |
|
getStub()
public LfpInventoryServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
LfpInventoryServiceStub |
|
insertLfpInventory(InsertLfpInventoryRequest request)
public final LfpInventory insertLfpInventory(InsertLfpInventoryRequest request)Inserts a LfpInventory resource for the given target merchant account. If the resource
already exists, it will be replaced. The inventory automatically expires after 30 days.
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 (LfpInventoryServiceClient lfpInventoryServiceClient = LfpInventoryServiceClient.create()) {
InsertLfpInventoryRequest request =
InsertLfpInventoryRequest.newBuilder()
.setParent(AccountName.of("[ACCOUNT]").toString())
.setLfpInventory(LfpInventory.newBuilder().build())
.build();
LfpInventory response = lfpInventoryServiceClient.insertLfpInventory(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
InsertLfpInventoryRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
LfpInventory |
|
insertLfpInventoryCallable()
public final UnaryCallable<InsertLfpInventoryRequest,LfpInventory> insertLfpInventoryCallable()Inserts a LfpInventory resource for the given target merchant account. If the resource
already exists, it will be replaced. The inventory automatically expires after 30 days.
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 (LfpInventoryServiceClient lfpInventoryServiceClient = LfpInventoryServiceClient.create()) {
InsertLfpInventoryRequest request =
InsertLfpInventoryRequest.newBuilder()
.setParent(AccountName.of("[ACCOUNT]").toString())
.setLfpInventory(LfpInventory.newBuilder().build())
.build();
ApiFuture<LfpInventory> future =
lfpInventoryServiceClient.insertLfpInventoryCallable().futureCall(request);
// Do something.
LfpInventory response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<InsertLfpInventoryRequest,LfpInventory> |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()