Package com.google.cloud.billing.budgets.v1

Class BudgetServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class BudgetServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    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().

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

    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.

    • Constructor Detail

      • BudgetServiceClient

        protected BudgetServiceClient​(BudgetServiceSettings settings)
                       throws IOException
        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.
        Throws:
        IOException

    • Method Detail

      • create

        public static final BudgetServiceClient create​(BudgetServiceSettings settings)
                                        throws IOException
        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.
        Throws:
        IOException

      • create

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

      • createBudget

        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:
        parent - Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId}`.
        budget - Required. Budget to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createBudget

        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:
        parent - Required. The name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId}`.
        budget - Required. Budget to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createBudget

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createBudgetCallable

        public final com.google.api.gax.rpc.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();
 }

      • updateBudget

        public final Budget updateBudget​(Budget budget,
                                 com.google.protobuf.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:
        budget - Required. The updated budget object. The budget to update is specified by the budget name in the budget.
        updateMask - 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.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateBudget

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateBudgetCallable

        public final com.google.api.gax.rpc.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();
 }

      • getBudget

        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);
 }
        Parameters:
        name - Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getBudget

        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);
 }
        Parameters:
        name - Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getBudget

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getBudgetCallable

        public final com.google.api.gax.rpc.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();
 }

      • listBudgets

        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);
   }
 }
        Parameters:
        parent - Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listBudgets

        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);
   }
 }
        Parameters:
        parent - Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listBudgets

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listBudgetsPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listBudgetsCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • deleteBudget

        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);
 }
        Parameters:
        name - Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteBudget

        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);
 }
        Parameters:
        name - Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteBudget

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteBudgetCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteBudgetRequest,​com.google.protobuf.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();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource