# Class OnlineReturnPolicyServiceClient (1.21.0)

1.21.0 (latest) 1.19.0 1.16.0 1.15.0 1.13.0 1.11.0 1.10.0 1.8.0 1.6.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.26.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

|---|---|
| [GitHub Repository](https://github.com/googleapis/google-cloud-java/tree/main/java-shopping-merchant-accounts/google-shopping-merchant-accounts/src/main/java/com/google/shopping/merchant/accounts/v1/OnlineReturnPolicyServiceClient.java) | [Product Reference](https://developers.google.com/merchant/api) |

Service Description: The service facilitates the management of a business'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().

| Method | Description | Method Variants |
|---|---|---|
| GetOnlineReturnPolicy | Gets an existing return policy for a given business. | 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 for a given business. | 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() |
| CreateOnlineReturnPolicy | Creates a new return policy for a given business. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - createOnlineReturnPolicy(CreateOnlineReturnPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - createOnlineReturnPolicy(AccountName parent, OnlineReturnPolicy onlineReturnPolicy) - createOnlineReturnPolicy(String parent, OnlineReturnPolicy onlineReturnPolicy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - createOnlineReturnPolicyCallable() |
| DeleteOnlineReturnPolicy | Deletes an existing return policy. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - deleteOnlineReturnPolicy(DeleteOnlineReturnPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - deleteOnlineReturnPolicy(OnlineReturnPolicyName name) - deleteOnlineReturnPolicy(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. - deleteOnlineReturnPolicyCallable() |
[Methods]

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](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> OnlineReturnPolicyServiceClient

## Static Methods

### create()

    public static final OnlineReturnPolicyServiceClient create()

Constructs an instance of OnlineReturnPolicyServiceClient with default settings.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### 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` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceSettings` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### 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` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.stub.OnlineReturnPolicyServiceStub` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.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` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceSettings` |

### OnlineReturnPolicyServiceClient(OnlineReturnPolicyServiceStub stub)

    protected OnlineReturnPolicyServiceClient(OnlineReturnPolicyServiceStub stub)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.stub.OnlineReturnPolicyServiceStub` |

## Methods

### awaitTermination(long duration, TimeUnit unit)

    public boolean awaitTermination(long duration, TimeUnit unit)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `duration` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |
| `unit` | `https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html` |   |

### close()

    public final void close()

### createOnlineReturnPolicy(AccountName parent, OnlineReturnPolicy onlineReturnPolicy)

    public final OnlineReturnPolicy createOnlineReturnPolicy(AccountName parent, OnlineReturnPolicy onlineReturnPolicy)

Creates a new return policy for a given business.

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]");
       OnlineReturnPolicy onlineReturnPolicy = OnlineReturnPolicy.newBuilder().build();
       OnlineReturnPolicy response =
           onlineReturnPolicyServiceClient.createOnlineReturnPolicy(parent, onlineReturnPolicy);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.AccountName` Required. The Merchant Center account for which the return policy will be created. Format: `accounts/{account}` |
| `onlineReturnPolicy` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` Required. The return policy object to create. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` |   |

### createOnlineReturnPolicy(CreateOnlineReturnPolicyRequest request)

    public final OnlineReturnPolicy createOnlineReturnPolicy(CreateOnlineReturnPolicyRequest request)

Creates a new return policy for a given business.

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()) {
       CreateOnlineReturnPolicyRequest request =
           CreateOnlineReturnPolicyRequest.newBuilder()
               .setParent(AccountName.of("[ACCOUNT]").toString())
               .setOnlineReturnPolicy(OnlineReturnPolicy.newBuilder().build())
               .build();
       OnlineReturnPolicy response =
           onlineReturnPolicyServiceClient.createOnlineReturnPolicy(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.CreateOnlineReturnPolicyRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` |   |

### createOnlineReturnPolicy(String parent, OnlineReturnPolicy onlineReturnPolicy)

    public final OnlineReturnPolicy createOnlineReturnPolicy(String parent, OnlineReturnPolicy onlineReturnPolicy)

Creates a new return policy for a given business.

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();
       OnlineReturnPolicy onlineReturnPolicy = OnlineReturnPolicy.newBuilder().build();
       OnlineReturnPolicy response =
           onlineReturnPolicyServiceClient.createOnlineReturnPolicy(parent, onlineReturnPolicy);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The Merchant Center account for which the return policy will be created. Format: `accounts/{account}` |
| `onlineReturnPolicy` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` Required. The return policy object to create. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` |   |

### createOnlineReturnPolicyCallable()

    public final UnaryCallable<CreateOnlineReturnPolicyRequest,OnlineReturnPolicy> createOnlineReturnPolicyCallable()

Creates a new return policy for a given business.

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()) {
       CreateOnlineReturnPolicyRequest request =
           CreateOnlineReturnPolicyRequest.newBuilder()
               .setParent(AccountName.of("[ACCOUNT]").toString())
               .setOnlineReturnPolicy(OnlineReturnPolicy.newBuilder().build())
               .build();
       ApiFuture<OnlineReturnPolicy> future =
           onlineReturnPolicyServiceClient.createOnlineReturnPolicyCallable().futureCall(request);
       // Do something.
       OnlineReturnPolicy response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.CreateOnlineReturnPolicyRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy>` |   |

### deleteOnlineReturnPolicy(DeleteOnlineReturnPolicyRequest request)

    public final void deleteOnlineReturnPolicy(DeleteOnlineReturnPolicyRequest request)

Deletes 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()) {
       DeleteOnlineReturnPolicyRequest request =
           DeleteOnlineReturnPolicyRequest.newBuilder()
               .setName(OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]").toString())
               .build();
       onlineReturnPolicyServiceClient.deleteOnlineReturnPolicy(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.DeleteOnlineReturnPolicyRequest` The request object containing all of the parameters for the API call. |

### deleteOnlineReturnPolicy(OnlineReturnPolicyName name)

    public final void deleteOnlineReturnPolicy(OnlineReturnPolicyName name)

Deletes 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]");
       onlineReturnPolicyServiceClient.deleteOnlineReturnPolicy(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyName` Required. The name of the return policy to delete. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}` |

### deleteOnlineReturnPolicy(String name)

    public final void deleteOnlineReturnPolicy(String name)

Deletes 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();
       onlineReturnPolicyServiceClient.deleteOnlineReturnPolicy(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the return policy to delete. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}` |

### deleteOnlineReturnPolicyCallable()

    public final UnaryCallable<DeleteOnlineReturnPolicyRequest,Empty> deleteOnlineReturnPolicyCallable()

Deletes 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()) {
       DeleteOnlineReturnPolicyRequest request =
           DeleteOnlineReturnPolicyRequest.newBuilder()
               .setName(OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]").toString())
               .build();
       ApiFuture<Empty> future =
           onlineReturnPolicyServiceClient.deleteOnlineReturnPolicyCallable().futureCall(request);
       // Do something.
       future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.DeleteOnlineReturnPolicyRequest,https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Empty.html>` |   |

### getOnlineReturnPolicy(GetOnlineReturnPolicyRequest request)

    public final OnlineReturnPolicy getOnlineReturnPolicy(GetOnlineReturnPolicyRequest request)

Gets an existing return policy for a given business.

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` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.GetOnlineReturnPolicyRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` |   |

### getOnlineReturnPolicy(OnlineReturnPolicyName name)

    public final OnlineReturnPolicy getOnlineReturnPolicy(OnlineReturnPolicyName name)

Gets an existing return policy for a given business.

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` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyName` Required. The name of the return policy to retrieve. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` |   |

### getOnlineReturnPolicy(String name)

    public final OnlineReturnPolicy getOnlineReturnPolicy(String name)

Gets an existing return policy for a given business.

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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the return policy to retrieve. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy` |   |

### getOnlineReturnPolicyCallable()

    public final UnaryCallable<GetOnlineReturnPolicyRequest,OnlineReturnPolicy> getOnlineReturnPolicyCallable()

Gets an existing return policy for a given business.

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** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.GetOnlineReturnPolicyRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicy>` |   |

### getSettings()

    public final OnlineReturnPolicyServiceSettings getSettings()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceSettings` |   |

### getStub()

    public OnlineReturnPolicyServiceStub getStub()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.stub.OnlineReturnPolicyServiceStub` |   |

### isShutdown()

    public boolean isShutdown()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### isTerminated()

    public boolean isTerminated()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### listOnlineReturnPolicies(AccountName parent)

    public final OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse listOnlineReturnPolicies(AccountName parent)

Lists all existing return policies for a given business.

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` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.AccountName` Required. The Merchant Center account for which to list return policies. Format: `accounts/{account}` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse` |   |

### listOnlineReturnPolicies(ListOnlineReturnPoliciesRequest request)

    public final OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse listOnlineReturnPolicies(ListOnlineReturnPoliciesRequest request)

Lists all existing return policies for a given business.

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` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.ListOnlineReturnPoliciesRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse` |   |

### listOnlineReturnPolicies(String parent)

    public final OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse listOnlineReturnPolicies(String parent)

Lists all existing return policies for a given business.

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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The Merchant Center account for which to list return policies. Format: `accounts/{account}` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse` |   |

### listOnlineReturnPoliciesCallable()

    public final UnaryCallable<ListOnlineReturnPoliciesRequest,ListOnlineReturnPoliciesResponse> listOnlineReturnPoliciesCallable()

Lists all existing return policies for a given business.

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** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.ListOnlineReturnPoliciesRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.ListOnlineReturnPoliciesResponse>` |   |

### listOnlineReturnPoliciesPagedCallable()

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

Lists all existing return policies for a given business.

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** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.ListOnlineReturnPoliciesRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceClient.ListOnlineReturnPoliciesPagedResponse>` |   |

### shutdown()

    public void shutdown()

### shutdownNow()

    public void shutdownNow()