# Class BudgetServiceClient (2.93.0)

2.93.0 (latest) 2.91.0 2.88.0 2.87.0 2.85.0 2.83.0 2.82.0 2.81.0 2.80.0 2.78.0 2.76.0 2.75.0 2.74.0 2.73.0 2.72.0 2.70.0 2.68.0 2.67.0 2.64.0 2.63.0 2.62.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.53.0 2.52.0 2.51.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.6 2.2.0 2.1.7

|---|---|
| [GitHub Repository](https://github.com/googleapis/google-cloud-java/tree/main/java-billingbudgets/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/BudgetServiceClient.java) | [Product Reference](https://cloud.google.com/billing/docs/how-to/budgets) |

Service Description: BudgetService stores Cloud Billing budgets, which define a budget plan and
rules to execute as we track spend against that plan.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
       Budget budget = Budget.newBuilder().build();
       Budget response = budgetServiceClient.createBudget(parent, budget);
     }
     
Note: close() needs to be called on the BudgetServiceClient 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 |
|---|---|---|
| CreateBudget | Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - createBudget(CreateBudgetRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - createBudget(BillingAccountName parent, Budget budget) - createBudget(String parent, Budget budget) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - createBudgetCallable() |
| UpdateBudget | Updates a budget and returns the updated budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - updateBudget(UpdateBudgetRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - updateBudget(Budget budget, 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. - updateBudgetCallable() |
| GetBudget | Returns a budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - getBudget(GetBudgetRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - getBudget(BudgetName name) - getBudget(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. - getBudgetCallable() |
| ListBudgets | Returns a list of budgets for a billing account. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - listBudgets(ListBudgetsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - listBudgets(BillingAccountName parent) - listBudgets(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. - listBudgetsPagedCallable() - listBudgetsCallable() |
| DeleteBudget | Deletes a budget. Returns successfully if already deleted. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - deleteBudget(DeleteBudgetRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - deleteBudget(BudgetName name) - deleteBudget(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. - deleteBudgetCallable() |
[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 BudgetServiceSettings 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
     BudgetServiceSettings budgetServiceSettings =
         BudgetServiceSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     BudgetServiceClient budgetServiceClient = BudgetServiceClient.create(budgetServiceSettings);
     
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
     BudgetServiceSettings budgetServiceSettings =
         BudgetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
     BudgetServiceClient budgetServiceClient = BudgetServiceClient.create(budgetServiceSettings);
     
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
     BudgetServiceSettings budgetServiceSettings =
         BudgetServiceSettings.newHttpJsonBuilder().build();
     BudgetServiceClient budgetServiceClient = BudgetServiceClient.create(budgetServiceSettings);
     
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) \> BudgetServiceClient

## Static Methods

### create()

    public static final BudgetServiceClient create()

Constructs an instance of BudgetServiceClient with default settings.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceClient` |   |

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

### create(BudgetServiceSettings settings)

    public static final BudgetServiceClient create(BudgetServiceSettings settings)

Constructs an instance of BudgetServiceClient, 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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceSettings` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceClient` |   |

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

### create(BudgetServiceStub stub)

    public static final BudgetServiceClient create(BudgetServiceStub stub)

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.stub.BudgetServiceStub` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceClient` |   |

## Constructors

### BudgetServiceClient(BudgetServiceSettings settings)

    protected BudgetServiceClient(BudgetServiceSettings settings)

Constructs an instance of BudgetServiceClient, 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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceSettings` |

### BudgetServiceClient(BudgetServiceStub stub)

    protected BudgetServiceClient(BudgetServiceStub stub)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.stub.BudgetServiceStub` |

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

### createBudget(BillingAccountName parent, Budget budget)

    public final Budget createBudget(BillingAccountName parent, Budget budget)

Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more
information on the limits of the number of budgets you can create.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
       Budget budget = Budget.newBuilder().build();
       Budget response = budgetServiceClient.createBudget(parent, budget);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BillingAccountName` Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId}`. |
| `budget` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` Required. Budget to create. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### createBudget(CreateBudgetRequest request)

    public final Budget createBudget(CreateBudgetRequest request)

Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more
information on the limits of the number of budgets you can create.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       CreateBudgetRequest request =
           CreateBudgetRequest.newBuilder()
               .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
               .setBudget(Budget.newBuilder().build())
               .build();
       Budget response = budgetServiceClient.createBudget(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.CreateBudgetRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### createBudget(String parent, Budget budget)

    public final Budget createBudget(String parent, Budget budget)

Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more
information on the limits of the number of budgets you can create.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       String parent = BillingAccountName.of("[BILLING_ACCOUNT]").toString();
       Budget budget = Budget.newBuilder().build();
       Budget response = budgetServiceClient.createBudget(parent, budget);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId}`. |
| `budget` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` Required. Budget to create. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### createBudgetCallable()

    public final UnaryCallable<CreateBudgetRequest,Budget> createBudgetCallable()

Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more
information on the limits of the number of budgets you can create.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       CreateBudgetRequest request =
           CreateBudgetRequest.newBuilder()
               .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
               .setBudget(Budget.newBuilder().build())
               .build();
       ApiFuture<Budget> future = budgetServiceClient.createBudgetCallable().futureCall(request);
       // Do something.
       Budget 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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.CreateBudgetRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget>` |   |

### deleteBudget(BudgetName name)

    public final void deleteBudget(BudgetName name)

Deletes a budget. Returns successfully if already deleted.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       BudgetName name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]");
       budgetServiceClient.deleteBudget(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetName` Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. |

### deleteBudget(DeleteBudgetRequest request)

    public final void deleteBudget(DeleteBudgetRequest request)

Deletes a budget. Returns successfully if already deleted.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       DeleteBudgetRequest request =
           DeleteBudgetRequest.newBuilder()
               .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
               .build();
       budgetServiceClient.deleteBudget(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.DeleteBudgetRequest` The request object containing all of the parameters for the API call. |

### deleteBudget(String name)

    public final void deleteBudget(String name)

Deletes a budget. Returns successfully if already deleted.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       String name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString();
       budgetServiceClient.deleteBudget(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. |

### deleteBudgetCallable()

    public final UnaryCallable<DeleteBudgetRequest,Empty> deleteBudgetCallable()

Deletes a budget. Returns successfully if already deleted.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       DeleteBudgetRequest request =
           DeleteBudgetRequest.newBuilder()
               .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
               .build();
       ApiFuture<Empty> future = budgetServiceClient.deleteBudgetCallable().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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.DeleteBudgetRequest,https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Empty.html>` |   |

### getBudget(BudgetName name)

    public final Budget getBudget(BudgetName name)

Returns a budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       BudgetName name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]");
       Budget response = budgetServiceClient.getBudget(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetName` Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### getBudget(GetBudgetRequest request)

    public final Budget getBudget(GetBudgetRequest request)

Returns a budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       GetBudgetRequest request =
           GetBudgetRequest.newBuilder()
               .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
               .build();
       Budget response = budgetServiceClient.getBudget(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.GetBudgetRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### getBudget(String name)

    public final Budget getBudget(String name)

Returns a budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       String name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString();
       Budget response = budgetServiceClient.getBudget(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### getBudgetCallable()

    public final UnaryCallable<GetBudgetRequest,Budget> getBudgetCallable()

Returns a budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       GetBudgetRequest request =
           GetBudgetRequest.newBuilder()
               .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
               .build();
       ApiFuture<Budget> future = budgetServiceClient.getBudgetCallable().futureCall(request);
       // Do something.
       Budget 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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.GetBudgetRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget>` |   |

### getSettings()

    public final BudgetServiceSettings getSettings()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceSettings` |   |

### getStub()

    public BudgetServiceStub getStub()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.stub.BudgetServiceStub` |   |

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

### listBudgets(BillingAccountName parent)

    public final BudgetServiceClient.ListBudgetsPagedResponse listBudgets(BillingAccountName parent)

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
       for (Budget element : budgetServiceClient.listBudgets(parent).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BillingAccountName` Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId}`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceClient.ListBudgetsPagedResponse` |   |

### listBudgets(ListBudgetsRequest request)

    public final BudgetServiceClient.ListBudgetsPagedResponse listBudgets(ListBudgetsRequest request)

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       ListBudgetsRequest request =
           ListBudgetsRequest.newBuilder()
               .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
               .setScope("scope109264468")
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .build();
       for (Budget element : budgetServiceClient.listBudgets(request).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.ListBudgetsRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceClient.ListBudgetsPagedResponse` |   |

### listBudgets(String parent)

    public final BudgetServiceClient.ListBudgetsPagedResponse listBudgets(String parent)

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       String parent = BillingAccountName.of("[BILLING_ACCOUNT]").toString();
       for (Budget element : budgetServiceClient.listBudgets(parent).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId}`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceClient.ListBudgetsPagedResponse` |   |

### listBudgetsCallable()

    public final UnaryCallable<ListBudgetsRequest,ListBudgetsResponse> listBudgetsCallable()

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       ListBudgetsRequest request =
           ListBudgetsRequest.newBuilder()
               .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
               .setScope("scope109264468")
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .build();
       while (true) {
         ListBudgetsResponse response = budgetServiceClient.listBudgetsCallable().call(request);
         for (Budget element : response.getBudgetsList()) {
           // 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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.ListBudgetsRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.ListBudgetsResponse>` |   |

### listBudgetsPagedCallable()

    public final UnaryCallable<ListBudgetsRequest,BudgetServiceClient.ListBudgetsPagedResponse> listBudgetsPagedCallable()

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. When reading from the API, you will not see these fields in the return value, though
they may have been set in the Cloud Console.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       ListBudgetsRequest request =
           ListBudgetsRequest.newBuilder()
               .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
               .setScope("scope109264468")
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .build();
       ApiFuture<Budget> future = budgetServiceClient.listBudgetsPagedCallable().futureCall(request);
       // Do something.
       for (Budget 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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.ListBudgetsRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.BudgetServiceClient.ListBudgetsPagedResponse>` |   |

### shutdown()

    public void shutdown()

### shutdownNow()

    public void shutdownNow()

### updateBudget(Budget budget, FieldMask updateMask)

    public final Budget updateBudget(Budget budget, FieldMask updateMask)

Updates a budget and returns the updated budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. Budget fields that are not exposed in this API will not be changed by this method.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       Budget budget = Budget.newBuilder().build();
       FieldMask updateMask = FieldMask.newBuilder().build();
       Budget response = budgetServiceClient.updateBudget(budget, updateMask);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `budget` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` Required. The updated budget object. The budget to update is specified by the budget name in the budget. |
| `updateMask` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask.html` Optional. Indicates which fields in the provided budget to update. Read-only fields (such as `name`) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See <https://developers.google.com/protocol-buffers/docs/proto3#default> for more details about default values. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### updateBudget(UpdateBudgetRequest request)

    public final Budget updateBudget(UpdateBudgetRequest request)

Updates a budget and returns the updated budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. Budget fields that are not exposed in this API will not be changed by this method.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       UpdateBudgetRequest request =
           UpdateBudgetRequest.newBuilder()
               .setBudget(Budget.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       Budget response = budgetServiceClient.updateBudget(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.UpdateBudgetRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget` |   |

### updateBudgetCallable()

    public final UnaryCallable<UpdateBudgetRequest,Budget> updateBudgetCallable()

Updates a budget and returns the updated budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on
this API. Budget fields that are not exposed in this API will not be changed by this method.

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 (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
       UpdateBudgetRequest request =
           UpdateBudgetRequest.newBuilder()
               .setBudget(Budget.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       ApiFuture<Budget> future = budgetServiceClient.updateBudgetCallable().futureCall(request);
       // Do something.
       Budget 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-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.UpdateBudgetRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-billingbudgets/latest/com.google.cloud.billing.budgets.v1.Budget>` |   |