Class OnlineReturnPolicyServiceClient (0.3.0)

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

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.

Constructs an instance of OnlineReturnPolicyServiceClient with default 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.

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

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.

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);
 }
 

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);
 }
 

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);
 }
 

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

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);
   }
 }
 

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);
   }
 }
 

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);
   }
 }
 

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;
     }
   }
 }
 

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);
   }
 }