# Class AccountLimitsServiceClient (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.33.0 0.31.0 0.30.0 0.27.0 0.26.0 0.25.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0

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

Service Description: Service to retrieve account limits.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       AccountLimitName name = AccountLimitName.of("[ACCOUNT]", "[LIMIT]");
       AccountLimit response = accountLimitsServiceClient.getAccountLimit(name);
     }
     
Note: close() needs to be called on the AccountLimitsServiceClient 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 |
|---|---|---|
| GetAccountLimit | Retrieves an account limit. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - getAccountLimit(GetAccountLimitRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - getAccountLimit(AccountLimitName name) - getAccountLimit(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. - getAccountLimitCallable() |
| ListAccountLimits | Lists the limits of an account. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - listAccountLimits(ListAccountLimitsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - listAccountLimits(AccountName parent) - listAccountLimits(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. - listAccountLimitsPagedCallable() - listAccountLimitsCallable() |
[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 AccountLimitsServiceSettings
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
     AccountLimitsServiceSettings accountLimitsServiceSettings =
         AccountLimitsServiceSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create(accountLimitsServiceSettings);
     
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
     AccountLimitsServiceSettings accountLimitsServiceSettings =
         AccountLimitsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
     AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create(accountLimitsServiceSettings);
     
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
     AccountLimitsServiceSettings accountLimitsServiceSettings =
         AccountLimitsServiceSettings.newHttpJsonBuilder().build();
     AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create(accountLimitsServiceSettings);
     
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) \> AccountLimitsServiceClient

## Static Methods

### create()

    public static final AccountLimitsServiceClient create()

Constructs an instance of AccountLimitsServiceClient with default settings.

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

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

### create(AccountLimitsServiceSettings settings)

    public static final AccountLimitsServiceClient create(AccountLimitsServiceSettings settings)

Constructs an instance of AccountLimitsServiceClient, 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-quota/latest/com.google.shopping.merchant.quota.v1.AccountLimitsServiceSettings` |

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

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

### create(AccountLimitsServiceStub stub)

    public static final AccountLimitsServiceClient create(AccountLimitsServiceStub stub)

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

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

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

## Constructors

### AccountLimitsServiceClient(AccountLimitsServiceSettings settings)

    protected AccountLimitsServiceClient(AccountLimitsServiceSettings settings)

Constructs an instance of AccountLimitsServiceClient, 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-quota/latest/com.google.shopping.merchant.quota.v1.AccountLimitsServiceSettings` |

### AccountLimitsServiceClient(AccountLimitsServiceStub stub)

    protected AccountLimitsServiceClient(AccountLimitsServiceStub stub)

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

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

### getAccountLimit(AccountLimitName name)

    public final AccountLimit getAccountLimit(AccountLimitName name)

Retrieves an account limit.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       AccountLimitName name = AccountLimitName.of("[ACCOUNT]", "[LIMIT]");
       AccountLimit response = accountLimitsServiceClient.getAccountLimit(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/com.google.shopping.merchant.quota.v1.AccountLimitName` Required. The name of the limit to retrieve. Format: `accounts/{account}/limits/{limit}` For example: `accounts/123/limits/products~ADS_NON_EEA` |

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

### getAccountLimit(GetAccountLimitRequest request)

    public final AccountLimit getAccountLimit(GetAccountLimitRequest request)

Retrieves an account limit.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       GetAccountLimitRequest request =
           GetAccountLimitRequest.newBuilder()
               .setName(AccountLimitName.of("[ACCOUNT]", "[LIMIT]").toString())
               .build();
       AccountLimit response = accountLimitsServiceClient.getAccountLimit(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/com.google.shopping.merchant.quota.v1.GetAccountLimitRequest` 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-quota/latest/com.google.shopping.merchant.quota.v1.AccountLimit` |   |

### getAccountLimit(String name)

    public final AccountLimit getAccountLimit(String name)

Retrieves an account limit.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       String name = AccountLimitName.of("[ACCOUNT]", "[LIMIT]").toString();
       AccountLimit response = accountLimitsServiceClient.getAccountLimit(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the limit to retrieve. Format: `accounts/{account}/limits/{limit}` For example: `accounts/123/limits/products~ADS_NON_EEA` |

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

### getAccountLimitCallable()

    public final UnaryCallable<GetAccountLimitRequest,AccountLimit> getAccountLimitCallable()

Retrieves an account limit.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       GetAccountLimitRequest request =
           GetAccountLimitRequest.newBuilder()
               .setName(AccountLimitName.of("[ACCOUNT]", "[LIMIT]").toString())
               .build();
       ApiFuture<AccountLimit> future =
           accountLimitsServiceClient.getAccountLimitCallable().futureCall(request);
       // Do something.
       AccountLimit 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-quota/latest/com.google.shopping.merchant.quota.v1.GetAccountLimitRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/com.google.shopping.merchant.quota.v1.AccountLimit>` |   |

### getSettings()

    public final AccountLimitsServiceSettings getSettings()

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

### getStub()

    public AccountLimitsServiceStub getStub()

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

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

### listAccountLimits(AccountName parent)

    public final AccountLimitsServiceClient.ListAccountLimitsPagedResponse listAccountLimits(AccountName parent)

Lists the limits of an account.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       AccountName parent = AccountName.of("[ACCOUNT]");
       for (AccountLimit element :
           accountLimitsServiceClient.listAccountLimits(parent).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/com.google.shopping.merchant.quota.v1.AccountName` Required. The parent account. Format: `accounts/{account}` |

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

### listAccountLimits(ListAccountLimitsRequest request)

    public final AccountLimitsServiceClient.ListAccountLimitsPagedResponse listAccountLimits(ListAccountLimitsRequest request)

Lists the limits of an account.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       ListAccountLimitsRequest request =
           ListAccountLimitsRequest.newBuilder()
               .setParent(AccountName.of("[ACCOUNT]").toString())
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .setFilter("filter-1274492040")
               .build();
       for (AccountLimit element :
           accountLimitsServiceClient.listAccountLimits(request).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/com.google.shopping.merchant.quota.v1.ListAccountLimitsRequest` 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-quota/latest/com.google.shopping.merchant.quota.v1.AccountLimitsServiceClient.ListAccountLimitsPagedResponse` |   |

### listAccountLimits(String parent)

    public final AccountLimitsServiceClient.ListAccountLimitsPagedResponse listAccountLimits(String parent)

Lists the limits of an account.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       String parent = AccountName.of("[ACCOUNT]").toString();
       for (AccountLimit element :
           accountLimitsServiceClient.listAccountLimits(parent).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The parent account. Format: `accounts/{account}` |

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

### listAccountLimitsCallable()

    public final UnaryCallable<ListAccountLimitsRequest,ListAccountLimitsResponse> listAccountLimitsCallable()

Lists the limits of an account.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       ListAccountLimitsRequest request =
           ListAccountLimitsRequest.newBuilder()
               .setParent(AccountName.of("[ACCOUNT]").toString())
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .setFilter("filter-1274492040")
               .build();
       while (true) {
         ListAccountLimitsResponse response =
             accountLimitsServiceClient.listAccountLimitsCallable().call(request);
         for (AccountLimit element : response.getAccountLimitsList()) {
           // 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-quota/latest/com.google.shopping.merchant.quota.v1.ListAccountLimitsRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/com.google.shopping.merchant.quota.v1.ListAccountLimitsResponse>` |   |

### listAccountLimitsPagedCallable()

    public final UnaryCallable<ListAccountLimitsRequest,AccountLimitsServiceClient.ListAccountLimitsPagedResponse> listAccountLimitsPagedCallable()

Lists the limits of an account.

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 (AccountLimitsServiceClient accountLimitsServiceClient =
         AccountLimitsServiceClient.create()) {
       ListAccountLimitsRequest request =
           ListAccountLimitsRequest.newBuilder()
               .setParent(AccountName.of("[ACCOUNT]").toString())
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .setFilter("filter-1274492040")
               .build();
       ApiFuture<AccountLimit> future =
           accountLimitsServiceClient.listAccountLimitsPagedCallable().futureCall(request);
       // Do something.
       for (AccountLimit 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-quota/latest/com.google.shopping.merchant.quota.v1.ListAccountLimitsRequest,https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/com.google.shopping.merchant.quota.v1.AccountLimitsServiceClient.ListAccountLimitsPagedResponse>` |   |

### shutdown()

    public void shutdown()

### shutdownNow()

    public void shutdownNow()