Class OnlineReturnPolicyServiceClient (0.9.0)

GitHub RepositoryProduct Reference

Service Description: The service facilitates the management of a merchant's remorse return policy configuration, encompassing return policies for both ads and free listings ## programs. This API defines the following resource model:

OnlineReturnPolicy

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   OnlineReturnPolicyName name = OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]");
   OnlineReturnPolicy response = onlineReturnPolicyServiceClient.getOnlineReturnPolicy(name);
 }

Note: close() needs to be called on the OnlineReturnPolicyServiceClient 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

GetOnlineReturnPolicy

Gets an existing return policy.

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

  • getOnlineReturnPolicy(GetOnlineReturnPolicyRequest request)

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

  • getOnlineReturnPolicy(OnlineReturnPolicyName name)

  • getOnlineReturnPolicy(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.

  • getOnlineReturnPolicyCallable()

ListOnlineReturnPolicies

Lists all existing return policies.

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

  • listOnlineReturnPolicies(ListOnlineReturnPoliciesRequest request)

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

  • listOnlineReturnPolicies(AccountName parent)

  • listOnlineReturnPolicies(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.

  • listOnlineReturnPoliciesPagedCallable()

  • listOnlineReturnPoliciesCallable()

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 OnlineReturnPolicyServiceSettings 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
 OnlineReturnPolicyServiceSettings onlineReturnPolicyServiceSettings =
     OnlineReturnPolicyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create(onlineReturnPolicyServiceSettings);

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
 OnlineReturnPolicyServiceSettings onlineReturnPolicyServiceSettings =
     OnlineReturnPolicyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create(onlineReturnPolicyServiceSettings);

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
 OnlineReturnPolicyServiceSettings onlineReturnPolicyServiceSettings =
     OnlineReturnPolicyServiceSettings.newHttpJsonBuilder().build();
 OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create(onlineReturnPolicyServiceSettings);

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

Inheritance

java.lang.Object > OnlineReturnPolicyServiceClient

Static Methods

create()

public static final OnlineReturnPolicyServiceClient create()

Constructs an instance of OnlineReturnPolicyServiceClient with default settings.

Returns
Type Description
OnlineReturnPolicyServiceClient
Exceptions
Type Description
IOException

create(OnlineReturnPolicyServiceSettings settings)

public static final OnlineReturnPolicyServiceClient create(OnlineReturnPolicyServiceSettings settings)

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

create(OnlineReturnPolicyServiceStub stub)

public static final OnlineReturnPolicyServiceClient create(OnlineReturnPolicyServiceStub stub)

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

Parameter
Name Description
stub OnlineReturnPolicyServiceStub
Returns
Type Description
OnlineReturnPolicyServiceClient

Constructors

OnlineReturnPolicyServiceClient(OnlineReturnPolicyServiceSettings settings)

protected OnlineReturnPolicyServiceClient(OnlineReturnPolicyServiceSettings settings)

Constructs an instance of OnlineReturnPolicyServiceClient, 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 OnlineReturnPolicyServiceSettings

OnlineReturnPolicyServiceClient(OnlineReturnPolicyServiceStub stub)

protected OnlineReturnPolicyServiceClient(OnlineReturnPolicyServiceStub stub)
Parameter
Name Description
stub OnlineReturnPolicyServiceStub

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

getOnlineReturnPolicy(GetOnlineReturnPolicyRequest request)

public final OnlineReturnPolicy getOnlineReturnPolicy(GetOnlineReturnPolicyRequest request)

Gets an existing return policy.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   GetOnlineReturnPolicyRequest request =
       GetOnlineReturnPolicyRequest.newBuilder()
           .setName(OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]").toString())
           .build();
   OnlineReturnPolicy response = onlineReturnPolicyServiceClient.getOnlineReturnPolicy(request);
 }
Parameter
Name Description
request GetOnlineReturnPolicyRequest

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

getOnlineReturnPolicy(OnlineReturnPolicyName name)

public final OnlineReturnPolicy getOnlineReturnPolicy(OnlineReturnPolicyName name)

Gets an existing return policy.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   OnlineReturnPolicyName name = OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]");
   OnlineReturnPolicy response = onlineReturnPolicyServiceClient.getOnlineReturnPolicy(name);
 }
Parameter
Name Description
name OnlineReturnPolicyName

Required. The name of the return policy to retrieve. Format: accounts/{account}/onlineReturnPolicies/{return_policy}
Returns
Type Description
OnlineReturnPolicy

getOnlineReturnPolicy(String name)

public final OnlineReturnPolicy getOnlineReturnPolicy(String name)

Gets an existing return policy.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   String name = OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]").toString();
   OnlineReturnPolicy response = onlineReturnPolicyServiceClient.getOnlineReturnPolicy(name);
 }
Parameter
Name Description
name String

Required. The name of the return policy to retrieve. Format: accounts/{account}/onlineReturnPolicies/{return_policy}
Returns
Type Description
OnlineReturnPolicy

getOnlineReturnPolicyCallable()

public final UnaryCallable<GetOnlineReturnPolicyRequest,OnlineReturnPolicy> getOnlineReturnPolicyCallable()

Gets an existing return policy.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   GetOnlineReturnPolicyRequest request =
       GetOnlineReturnPolicyRequest.newBuilder()
           .setName(OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]").toString())
           .build();
   ApiFuture<OnlineReturnPolicy> future =
       onlineReturnPolicyServiceClient.getOnlineReturnPolicyCallable().futureCall(request);
   // Do something.
   OnlineReturnPolicy response = future.get();
 }
Returns
Type Description
UnaryCallable<GetOnlineReturnPolicyRequest,OnlineReturnPolicy>

getSettings()

public final OnlineReturnPolicyServiceSettings getSettings()
Returns
Type Description
OnlineReturnPolicyServiceSettings

getStub()

public OnlineReturnPolicyServiceStub getStub()
Returns
Type Description
OnlineReturnPolicyServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listOnlineReturnPolicies(AccountName parent)

public final OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse listOnlineReturnPolicies(AccountName parent)

Lists all existing return policies.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (OnlineReturnPolicy element :
       onlineReturnPolicyServiceClient.listOnlineReturnPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AccountName

Required. The merchant account for which to list return policies. Format: accounts/{account}
Returns
Type Description
OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse

listOnlineReturnPolicies(ListOnlineReturnPoliciesRequest request)

public final OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse listOnlineReturnPolicies(ListOnlineReturnPoliciesRequest request)

Lists all existing return policies.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   ListOnlineReturnPoliciesRequest request =
       ListOnlineReturnPoliciesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (OnlineReturnPolicy element :
       onlineReturnPolicyServiceClient.listOnlineReturnPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListOnlineReturnPoliciesRequest

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

listOnlineReturnPolicies(String parent)

public final OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse listOnlineReturnPolicies(String parent)

Lists all existing return policies.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (OnlineReturnPolicy element :
       onlineReturnPolicyServiceClient.listOnlineReturnPolicies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The merchant account for which to list return policies. Format: accounts/{account}
Returns
Type Description
OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse

listOnlineReturnPoliciesCallable()

public final UnaryCallable<ListOnlineReturnPoliciesRequest,ListOnlineReturnPoliciesResponse> listOnlineReturnPoliciesCallable()

Lists all existing return policies.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   ListOnlineReturnPoliciesRequest request =
       ListOnlineReturnPoliciesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListOnlineReturnPoliciesResponse response =
         onlineReturnPolicyServiceClient.listOnlineReturnPoliciesCallable().call(request);
     for (OnlineReturnPolicy element : response.getOnlineReturnPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListOnlineReturnPoliciesRequest,ListOnlineReturnPoliciesResponse>

listOnlineReturnPoliciesPagedCallable()

public final UnaryCallable<ListOnlineReturnPoliciesRequest,OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse> listOnlineReturnPoliciesPagedCallable()

Lists all existing return policies.

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 (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
     OnlineReturnPolicyServiceClient.create()) {
   ListOnlineReturnPoliciesRequest request =
       ListOnlineReturnPoliciesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<OnlineReturnPolicy> future =
       onlineReturnPolicyServiceClient
           .listOnlineReturnPoliciesPagedCallable()
           .futureCall(request);
   // Do something.
   for (OnlineReturnPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListOnlineReturnPoliciesRequest,ListOnlineReturnPoliciesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()