Class LfpMerchantStateServiceClient (0.21.0)

GitHub RepositoryProduct Reference

Service Description: Service for a LFP partner to get the state of 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 (LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create()) {
   LfpMerchantStateName name = LfpMerchantStateName.of("[ACCOUNT]", "[LFP_MERCHANT_STATE]");
   LfpMerchantState response = lfpMerchantStateServiceClient.getLfpMerchantState(name);
 }

Note: close() needs to be called on the LfpMerchantStateServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetLfpMerchantState

Gets the LFP state of a merchant

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLfpMerchantState(GetLfpMerchantStateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getLfpMerchantState(LfpMerchantStateName name)

  • getLfpMerchantState(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLfpMerchantStateCallable()

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 LfpMerchantStateServiceSettings 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
 LfpMerchantStateServiceSettings lfpMerchantStateServiceSettings =
     LfpMerchantStateServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create(lfpMerchantStateServiceSettings);

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
 LfpMerchantStateServiceSettings lfpMerchantStateServiceSettings =
     LfpMerchantStateServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create(lfpMerchantStateServiceSettings);

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
 LfpMerchantStateServiceSettings lfpMerchantStateServiceSettings =
     LfpMerchantStateServiceSettings.newHttpJsonBuilder().build();
 LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create(lfpMerchantStateServiceSettings);

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

Inheritance

java.lang.Object > LfpMerchantStateServiceClient

Static Methods

create()

public static final LfpMerchantStateServiceClient create()

Constructs an instance of LfpMerchantStateServiceClient with default settings.

Returns
Type Description
LfpMerchantStateServiceClient
Exceptions
Type Description
IOException

create(LfpMerchantStateServiceSettings settings)

public static final LfpMerchantStateServiceClient create(LfpMerchantStateServiceSettings settings)

Constructs an instance of LfpMerchantStateServiceClient, 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 LfpMerchantStateServiceSettings
Returns
Type Description
LfpMerchantStateServiceClient
Exceptions
Type Description
IOException

create(LfpMerchantStateServiceStub stub)

public static final LfpMerchantStateServiceClient create(LfpMerchantStateServiceStub stub)

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

Parameter
Name Description
stub LfpMerchantStateServiceStub
Returns
Type Description
LfpMerchantStateServiceClient

Constructors

LfpMerchantStateServiceClient(LfpMerchantStateServiceSettings settings)

protected LfpMerchantStateServiceClient(LfpMerchantStateServiceSettings settings)

Constructs an instance of LfpMerchantStateServiceClient, 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 LfpMerchantStateServiceSettings

LfpMerchantStateServiceClient(LfpMerchantStateServiceStub stub)

protected LfpMerchantStateServiceClient(LfpMerchantStateServiceStub stub)
Parameter
Name Description
stub LfpMerchantStateServiceStub

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

getLfpMerchantState(GetLfpMerchantStateRequest request)

public final LfpMerchantState getLfpMerchantState(GetLfpMerchantStateRequest request)

Gets the LFP state of a merchant

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 (LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create()) {
   GetLfpMerchantStateRequest request =
       GetLfpMerchantStateRequest.newBuilder()
           .setName(LfpMerchantStateName.of("[ACCOUNT]", "[LFP_MERCHANT_STATE]").toString())
           .build();
   LfpMerchantState response = lfpMerchantStateServiceClient.getLfpMerchantState(request);
 }
Parameter
Name Description
request GetLfpMerchantStateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
LfpMerchantState

getLfpMerchantState(LfpMerchantStateName name)

public final LfpMerchantState getLfpMerchantState(LfpMerchantStateName name)

Gets the LFP state of a merchant

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 (LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create()) {
   LfpMerchantStateName name = LfpMerchantStateName.of("[ACCOUNT]", "[LFP_MERCHANT_STATE]");
   LfpMerchantState response = lfpMerchantStateServiceClient.getLfpMerchantState(name);
 }
Parameter
Name Description
name LfpMerchantStateName

Required. The name of the state to retrieve. Format: accounts/{account}/lfpMerchantStates/{target_merchant}
Returns
Type Description
LfpMerchantState

getLfpMerchantState(String name)

public final LfpMerchantState getLfpMerchantState(String name)

Gets the LFP state of a merchant

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 (LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create()) {
   String name = LfpMerchantStateName.of("[ACCOUNT]", "[LFP_MERCHANT_STATE]").toString();
   LfpMerchantState response = lfpMerchantStateServiceClient.getLfpMerchantState(name);
 }
Parameter
Name Description
name String

Required. The name of the state to retrieve. Format: accounts/{account}/lfpMerchantStates/{target_merchant}
Returns
Type Description
LfpMerchantState

getLfpMerchantStateCallable()

public final UnaryCallable<GetLfpMerchantStateRequest,LfpMerchantState> getLfpMerchantStateCallable()

Gets the LFP state of a merchant

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 (LfpMerchantStateServiceClient lfpMerchantStateServiceClient =
     LfpMerchantStateServiceClient.create()) {
   GetLfpMerchantStateRequest request =
       GetLfpMerchantStateRequest.newBuilder()
           .setName(LfpMerchantStateName.of("[ACCOUNT]", "[LFP_MERCHANT_STATE]").toString())
           .build();
   ApiFuture<LfpMerchantState> future =
       lfpMerchantStateServiceClient.getLfpMerchantStateCallable().futureCall(request);
   // Do something.
   LfpMerchantState response = future.get();
 }
Returns
Type Description
UnaryCallable<GetLfpMerchantStateRequest,LfpMerchantState>

getSettings()

public final LfpMerchantStateServiceSettings getSettings()
Returns
Type Description
LfpMerchantStateServiceSettings

getStub()

public LfpMerchantStateServiceStub getStub()
Returns
Type Description
LfpMerchantStateServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()