Class LfpProvidersServiceClient (0.23.0)

Service Description: The service facilitates the management of a merchant's LFP provider settings. This API defines the following resource model: - LfpProvider

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   LfpProviderName name =
       LfpProviderName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]", "[LFP_PROVIDER]");
   LinkLfpProviderResponse response = lfpProvidersServiceClient.linkLfpProvider(name);
 }

Note: close() needs to be called on the LfpProvidersServiceClient 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
FindLfpProviders	Find the LFP provider candidates in a given country.	Request object method variants only take one parameter, a request object, which must be constructed before the call. findLfpProviders(FindLfpProvidersRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. findLfpProviders(OmnichannelSettingName parent) findLfpProviders(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. findLfpProvidersPagedCallable() findLfpProvidersCallable()
LinkLfpProvider	Link the specified merchant to a LFP provider for the specified country.	Request object method variants only take one parameter, a request object, which must be constructed before the call. linkLfpProvider(LinkLfpProviderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. linkLfpProvider(LfpProviderName name) linkLfpProvider(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. linkLfpProviderCallable()

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 LfpProvidersServiceSettings 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
 LfpProvidersServiceSettings lfpProvidersServiceSettings =
     LfpProvidersServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LfpProvidersServiceClient lfpProvidersServiceClient =
     LfpProvidersServiceClient.create(lfpProvidersServiceSettings);

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
 LfpProvidersServiceSettings lfpProvidersServiceSettings =
     LfpProvidersServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LfpProvidersServiceClient lfpProvidersServiceClient =
     LfpProvidersServiceClient.create(lfpProvidersServiceSettings);

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
 LfpProvidersServiceSettings lfpProvidersServiceSettings =
     LfpProvidersServiceSettings.newHttpJsonBuilder().build();
 LfpProvidersServiceClient lfpProvidersServiceClient =
     LfpProvidersServiceClient.create(lfpProvidersServiceSettings);

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

Inheritance

java.lang.Object > LfpProvidersServiceClient

Static Methods

create()

public static final LfpProvidersServiceClient create()

Constructs an instance of LfpProvidersServiceClient with default settings.

Returns
Type	Description
`LfpProvidersServiceClient`

Exceptions
Type	Description
`IOException`

create(LfpProvidersServiceSettings settings)

public static final LfpProvidersServiceClient create(LfpProvidersServiceSettings settings)

Constructs an instance of LfpProvidersServiceClient, 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`	`LfpProvidersServiceSettings`

Returns
Type	Description
`LfpProvidersServiceClient`

Exceptions
Type	Description
`IOException`

create(LfpProvidersServiceStub stub)

public static final LfpProvidersServiceClient create(LfpProvidersServiceStub stub)

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

Parameter
Name	Description
`stub`	`LfpProvidersServiceStub`

Returns
Type	Description
`LfpProvidersServiceClient`

Constructors

LfpProvidersServiceClient(LfpProvidersServiceSettings settings)

protected LfpProvidersServiceClient(LfpProvidersServiceSettings settings)

Constructs an instance of LfpProvidersServiceClient, 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`	`LfpProvidersServiceSettings`

LfpProvidersServiceClient(LfpProvidersServiceStub stub)

protected LfpProvidersServiceClient(LfpProvidersServiceStub stub)

Parameter
Name	Description
`stub`	`LfpProvidersServiceStub`

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

findLfpProviders(FindLfpProvidersRequest request)

public final LfpProvidersServiceClient.FindLfpProvidersPagedResponse findLfpProviders(FindLfpProvidersRequest request)

Find the LFP provider candidates in a given country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   FindLfpProvidersRequest request =
       FindLfpProvidersRequest.newBuilder()
           .setParent(OmnichannelSettingName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (LfpProvider element : lfpProvidersServiceClient.findLfpProviders(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`LfpProvidersServiceClient.FindLfpProvidersPagedResponse`

findLfpProviders(OmnichannelSettingName parent)

public final LfpProvidersServiceClient.FindLfpProvidersPagedResponse findLfpProviders(OmnichannelSettingName parent)

Find the LFP provider candidates in a given country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   OmnichannelSettingName parent =
       OmnichannelSettingName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]");
   for (LfpProvider element : lfpProvidersServiceClient.findLfpProviders(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`OmnichannelSettingName` Required. The name of the parent resource under which the LFP providers are found. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.

Returns
Type	Description
`LfpProvidersServiceClient.FindLfpProvidersPagedResponse`

findLfpProviders(String parent)

public final LfpProvidersServiceClient.FindLfpProvidersPagedResponse findLfpProviders(String parent)

Find the LFP provider candidates in a given country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   String parent = OmnichannelSettingName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]").toString();
   for (LfpProvider element : lfpProvidersServiceClient.findLfpProviders(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The name of the parent resource under which the LFP providers are found. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.

Returns
Type	Description
`LfpProvidersServiceClient.FindLfpProvidersPagedResponse`

findLfpProvidersCallable()

public final UnaryCallable<FindLfpProvidersRequest,FindLfpProvidersResponse> findLfpProvidersCallable()

Find the LFP provider candidates in a given country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   FindLfpProvidersRequest request =
       FindLfpProvidersRequest.newBuilder()
           .setParent(OmnichannelSettingName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     FindLfpProvidersResponse response =
         lfpProvidersServiceClient.findLfpProvidersCallable().call(request);
     for (LfpProvider element : response.getLfpProvidersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<FindLfpProvidersRequest,FindLfpProvidersResponse>`

findLfpProvidersPagedCallable()

public final UnaryCallable<FindLfpProvidersRequest,LfpProvidersServiceClient.FindLfpProvidersPagedResponse> findLfpProvidersPagedCallable()

Find the LFP provider candidates in a given country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   FindLfpProvidersRequest request =
       FindLfpProvidersRequest.newBuilder()
           .setParent(OmnichannelSettingName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<LfpProvider> future =
       lfpProvidersServiceClient.findLfpProvidersPagedCallable().futureCall(request);
   // Do something.
   for (LfpProvider element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<FindLfpProvidersRequest,FindLfpProvidersPagedResponse>`

getSettings()

public final LfpProvidersServiceSettings getSettings()

Returns
Type	Description
`LfpProvidersServiceSettings`

getStub()

public LfpProvidersServiceStub getStub()

Returns
Type	Description
`LfpProvidersServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

linkLfpProvider(LfpProviderName name)

public final LinkLfpProviderResponse linkLfpProvider(LfpProviderName name)

Link the specified merchant to a LFP provider for the specified country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   LfpProviderName name =
       LfpProviderName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]", "[LFP_PROVIDER]");
   LinkLfpProviderResponse response = lfpProvidersServiceClient.linkLfpProvider(name);
 }

Parameter
Name	Description
`name`	`LfpProviderName` Required. The name of the LFP provider resource to link. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}`. The `lfp_provider` is the LFP provider ID.

Returns
Type	Description
`LinkLfpProviderResponse`

linkLfpProvider(LinkLfpProviderRequest request)

public final LinkLfpProviderResponse linkLfpProvider(LinkLfpProviderRequest request)

Link the specified merchant to a LFP provider for the specified country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   LinkLfpProviderRequest request =
       LinkLfpProviderRequest.newBuilder()
           .setName(
               LfpProviderName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]", "[LFP_PROVIDER]")
                   .toString())
           .setExternalAccountId("externalAccountId1814989981")
           .build();
   LinkLfpProviderResponse response = lfpProvidersServiceClient.linkLfpProvider(request);
 }

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

Returns
Type	Description
`LinkLfpProviderResponse`

linkLfpProvider(String name)

public final LinkLfpProviderResponse linkLfpProvider(String name)

Link the specified merchant to a LFP provider for the specified country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   String name =
       LfpProviderName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]", "[LFP_PROVIDER]").toString();
   LinkLfpProviderResponse response = lfpProvidersServiceClient.linkLfpProvider(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the LFP provider resource to link. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}`. The `lfp_provider` is the LFP provider ID.

Returns
Type	Description
`LinkLfpProviderResponse`

linkLfpProviderCallable()

public final UnaryCallable<LinkLfpProviderRequest,LinkLfpProviderResponse> linkLfpProviderCallable()

Link the specified merchant to a LFP provider for the specified country.

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 (LfpProvidersServiceClient lfpProvidersServiceClient = LfpProvidersServiceClient.create()) {
   LinkLfpProviderRequest request =
       LinkLfpProviderRequest.newBuilder()
           .setName(
               LfpProviderName.of("[ACCOUNT]", "[OMNICHANNEL_SETTING]", "[LFP_PROVIDER]")
                   .toString())
           .setExternalAccountId("externalAccountId1814989981")
           .build();
   ApiFuture<LinkLfpProviderResponse> future =
       lfpProvidersServiceClient.linkLfpProviderCallable().futureCall(request);
   // Do something.
   LinkLfpProviderResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<LinkLfpProviderRequest,LinkLfpProviderResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class LfpProvidersServiceClient (0.23.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(LfpProvidersServiceSettings settings)

create(LfpProvidersServiceStub stub)

Constructors

LfpProvidersServiceClient(LfpProvidersServiceSettings settings)

LfpProvidersServiceClient(LfpProvidersServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

findLfpProviders(FindLfpProvidersRequest request)

findLfpProviders(OmnichannelSettingName parent)

findLfpProviders(String parent)

findLfpProvidersCallable()

findLfpProvidersPagedCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

linkLfpProvider(LfpProviderName name)

linkLfpProvider(LinkLfpProviderRequest request)

linkLfpProvider(String name)

linkLfpProviderCallable()

shutdown()

shutdownNow()

Class LfpProvidersServiceClient (0.23.0)