# Class CheckoutSettingsServiceClient (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

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

|---|---|
| [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/v1beta/CheckoutSettingsServiceClient.java) | [Product Reference](https://developers.google.com/merchant/api) |

Service Description: Service for supporting [checkout
settings](https://support.google.com/merchants/answer/13945960).

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       CheckoutSettingsName name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]");
       CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(name);
     }
     
Note: close() needs to be called on the CheckoutSettingsServiceClient 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 |
|---|---|---|
| GetCheckoutSettings | Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - getCheckoutSettings(GetCheckoutSettingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - getCheckoutSettings(CheckoutSettingsName name) - getCheckoutSettings(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. - getCheckoutSettingsCallable() |
| CreateCheckoutSettings | Creates `CheckoutSettings` for the given merchant. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - createCheckoutSettings(CreateCheckoutSettingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - createCheckoutSettings(ProgramName parent, CheckoutSettings checkoutSettings) - createCheckoutSettings(String parent, CheckoutSettings checkoutSettings) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - createCheckoutSettingsCallable() |
| UpdateCheckoutSettings | Updates `CheckoutSettings` for the given merchant. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - updateCheckoutSettings(UpdateCheckoutSettingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - updateCheckoutSettings(CheckoutSettings checkoutSettings, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - updateCheckoutSettingsCallable() |
| DeleteCheckoutSettings | Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - deleteCheckoutSettings(DeleteCheckoutSettingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - deleteCheckoutSettings(CheckoutSettingsName name) - deleteCheckoutSettings(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. - deleteCheckoutSettingsCallable() |
[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
CheckoutSettingsServiceSettings 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
     CheckoutSettingsServiceSettings checkoutSettingsServiceSettings =
         CheckoutSettingsServiceSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create(checkoutSettingsServiceSettings);
     
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
     CheckoutSettingsServiceSettings checkoutSettingsServiceSettings =
         CheckoutSettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
     CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create(checkoutSettingsServiceSettings);
     
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
     CheckoutSettingsServiceSettings checkoutSettingsServiceSettings =
         CheckoutSettingsServiceSettings.newHttpJsonBuilder().build();
     CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create(checkoutSettingsServiceSettings);
     
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) \> CheckoutSettingsServiceClient

## Static Methods

### create()

    public static final CheckoutSettingsServiceClient create()

Constructs an instance of CheckoutSettingsServiceClient with default settings.

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

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

### create(CheckoutSettingsServiceSettings settings)

    public static final CheckoutSettingsServiceClient create(CheckoutSettingsServiceSettings settings)

Constructs an instance of CheckoutSettingsServiceClient, 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.v1beta.CheckoutSettingsServiceSettings` |

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

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

### create(CheckoutSettingsServiceStub stub)

    public static final CheckoutSettingsServiceClient create(CheckoutSettingsServiceStub stub)

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

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

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

## Constructors

### CheckoutSettingsServiceClient(CheckoutSettingsServiceSettings settings)

    protected CheckoutSettingsServiceClient(CheckoutSettingsServiceSettings settings)

Constructs an instance of CheckoutSettingsServiceClient, 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.v1beta.CheckoutSettingsServiceSettings` |

### CheckoutSettingsServiceClient(CheckoutSettingsServiceStub stub)

    protected CheckoutSettingsServiceClient(CheckoutSettingsServiceStub stub)

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

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

### createCheckoutSettings(CreateCheckoutSettingsRequest request)

    public final CheckoutSettings createCheckoutSettings(CreateCheckoutSettingsRequest request)

Creates `CheckoutSettings` for the given merchant.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       CreateCheckoutSettingsRequest request =
           CreateCheckoutSettingsRequest.newBuilder()
               .setParent(ProgramName.of("[ACCOUNT]", "[PROGRAM]").toString())
               .setCheckoutSettings(CheckoutSettings.newBuilder().build())
               .build();
       CheckoutSettings response = checkoutSettingsServiceClient.createCheckoutSettings(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CreateCheckoutSettingsRequest` 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.v1beta.CheckoutSettings` |   |

### createCheckoutSettings(ProgramName parent, CheckoutSettings checkoutSettings)

    public final CheckoutSettings createCheckoutSettings(ProgramName parent, CheckoutSettings checkoutSettings)

Creates `CheckoutSettings` for the given merchant.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       ProgramName parent = ProgramName.of("[ACCOUNT]", "[PROGRAM]");
       CheckoutSettings checkoutSettings = CheckoutSettings.newBuilder().build();
       CheckoutSettings response =
           checkoutSettingsServiceClient.createCheckoutSettings(parent, checkoutSettings);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.ProgramName` Required. The merchant account for which the `CheckoutSettings` will be created. |
| `checkoutSettings` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettings` Required. The `CheckoutSettings` object to create. |

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

### createCheckoutSettings(String parent, CheckoutSettings checkoutSettings)

    public final CheckoutSettings createCheckoutSettings(String parent, CheckoutSettings checkoutSettings)

Creates `CheckoutSettings` for the given merchant.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       String parent = ProgramName.of("[ACCOUNT]", "[PROGRAM]").toString();
       CheckoutSettings checkoutSettings = CheckoutSettings.newBuilder().build();
       CheckoutSettings response =
           checkoutSettingsServiceClient.createCheckoutSettings(parent, checkoutSettings);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The merchant account for which the `CheckoutSettings` will be created. |
| `checkoutSettings` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettings` Required. The `CheckoutSettings` object to create. |

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

### createCheckoutSettingsCallable()

    public final UnaryCallable<CreateCheckoutSettingsRequest,CheckoutSettings> createCheckoutSettingsCallable()

Creates `CheckoutSettings` for the given merchant.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       CreateCheckoutSettingsRequest request =
           CreateCheckoutSettingsRequest.newBuilder()
               .setParent(ProgramName.of("[ACCOUNT]", "[PROGRAM]").toString())
               .setCheckoutSettings(CheckoutSettings.newBuilder().build())
               .build();
       ApiFuture<CheckoutSettings> future =
           checkoutSettingsServiceClient.createCheckoutSettingsCallable().futureCall(request);
       // Do something.
       CheckoutSettings 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.v1beta.CreateCheckoutSettingsRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettings>` |   |

### deleteCheckoutSettings(CheckoutSettingsName name)

    public final void deleteCheckoutSettings(CheckoutSettingsName name)

Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       CheckoutSettingsName name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]");
       checkoutSettingsServiceClient.deleteCheckoutSettings(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettingsName` Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` |

### deleteCheckoutSettings(DeleteCheckoutSettingsRequest request)

    public final void deleteCheckoutSettings(DeleteCheckoutSettingsRequest request)

Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       DeleteCheckoutSettingsRequest request =
           DeleteCheckoutSettingsRequest.newBuilder()
               .setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
               .build();
       checkoutSettingsServiceClient.deleteCheckoutSettings(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.DeleteCheckoutSettingsRequest` The request object containing all of the parameters for the API call. |

### deleteCheckoutSettings(String name)

    public final void deleteCheckoutSettings(String name)

Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       String name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString();
       checkoutSettingsServiceClient.deleteCheckoutSettings(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` |

### deleteCheckoutSettingsCallable()

    public final UnaryCallable<DeleteCheckoutSettingsRequest,Empty> deleteCheckoutSettingsCallable()

Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       DeleteCheckoutSettingsRequest request =
           DeleteCheckoutSettingsRequest.newBuilder()
               .setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
               .build();
       ApiFuture<Empty> future =
           checkoutSettingsServiceClient.deleteCheckoutSettingsCallable().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.v1beta.DeleteCheckoutSettingsRequest,https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Empty.html>` |   |

### getCheckoutSettings(CheckoutSettingsName name)

    public final CheckoutSettings getCheckoutSettings(CheckoutSettingsName name)

Gets `CheckoutSettings` for the given merchant. This includes information about review state,
enrollment state and URL settings.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       CheckoutSettingsName name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]");
       CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettingsName` Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` |

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

### getCheckoutSettings(GetCheckoutSettingsRequest request)

    public final CheckoutSettings getCheckoutSettings(GetCheckoutSettingsRequest request)

Gets `CheckoutSettings` for the given merchant. This includes information about review state,
enrollment state and URL settings.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       GetCheckoutSettingsRequest request =
           GetCheckoutSettingsRequest.newBuilder()
               .setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
               .build();
       CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.GetCheckoutSettingsRequest` 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.v1beta.CheckoutSettings` |   |

### getCheckoutSettings(String name)

    public final CheckoutSettings getCheckoutSettings(String name)

Gets `CheckoutSettings` for the given merchant. This includes information about review state,
enrollment state and URL settings.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       String name = CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString();
       CheckoutSettings response = checkoutSettingsServiceClient.getCheckoutSettings(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings` |

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

### getCheckoutSettingsCallable()

    public final UnaryCallable<GetCheckoutSettingsRequest,CheckoutSettings> getCheckoutSettingsCallable()

Gets `CheckoutSettings` for the given merchant. This includes information about review state,
enrollment state and URL settings.

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 (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       GetCheckoutSettingsRequest request =
           GetCheckoutSettingsRequest.newBuilder()
               .setName(CheckoutSettingsName.of("[ACCOUNT]", "[PROGRAM]").toString())
               .build();
       ApiFuture<CheckoutSettings> future =
           checkoutSettingsServiceClient.getCheckoutSettingsCallable().futureCall(request);
       // Do something.
       CheckoutSettings 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.v1beta.GetCheckoutSettingsRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettings>` |   |

### getSettings()

    public final CheckoutSettingsServiceSettings getSettings()

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

### getStub()

    public CheckoutSettingsServiceStub getStub()

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

### 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` |   |

### shutdown()

    public void shutdown()

### shutdownNow()

    public void shutdownNow()

### updateCheckoutSettings(CheckoutSettings checkoutSettings, FieldMask updateMask)

    public final CheckoutSettings updateCheckoutSettings(CheckoutSettings checkoutSettings, FieldMask updateMask)

Updates `CheckoutSettings` for the given merchant.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       CheckoutSettings checkoutSettings = CheckoutSettings.newBuilder().build();
       FieldMask updateMask = FieldMask.newBuilder().build();
       CheckoutSettings response =
           checkoutSettingsServiceClient.updateCheckoutSettings(checkoutSettings, updateMask);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `checkoutSettings` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettings` Required. The updated version of the `CheckoutSettings`. The `name` field is used to identify the `CheckoutSettings`. Format: `accounts/{account}/programs/{program}/checkoutSettings` |
| `updateMask` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask.html` Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings` |

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

### updateCheckoutSettings(UpdateCheckoutSettingsRequest request)

    public final CheckoutSettings updateCheckoutSettings(UpdateCheckoutSettingsRequest request)

Updates `CheckoutSettings` for the given merchant.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       UpdateCheckoutSettingsRequest request =
           UpdateCheckoutSettingsRequest.newBuilder()
               .setCheckoutSettings(CheckoutSettings.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       CheckoutSettings response = checkoutSettingsServiceClient.updateCheckoutSettings(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.UpdateCheckoutSettingsRequest` 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.v1beta.CheckoutSettings` |   |

### updateCheckoutSettingsCallable()

    public final UnaryCallable<UpdateCheckoutSettingsRequest,CheckoutSettings> updateCheckoutSettingsCallable()

Updates `CheckoutSettings` for the given merchant.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (CheckoutSettingsServiceClient checkoutSettingsServiceClient =
         CheckoutSettingsServiceClient.create()) {
       UpdateCheckoutSettingsRequest request =
           UpdateCheckoutSettingsRequest.newBuilder()
               .setCheckoutSettings(CheckoutSettings.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       ApiFuture<CheckoutSettings> future =
           checkoutSettingsServiceClient.updateCheckoutSettingsCallable().futureCall(request);
       // Do something.
       CheckoutSettings 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.v1beta.UpdateCheckoutSettingsRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-accounts/latest/com.google.shopping.merchant.accounts.v1beta.CheckoutSettings>` |   |