Class BudgetServiceClient
- java.lang.Object
-
- com.google.cloud.billing.budgets.v1beta1.BudgetServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@BetaApi @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()) { CreateBudgetRequest request = CreateBudgetRequest.newBuilder() .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString()) .setBudget(Budget.newBuilder().build()) .build(); Budget response = budgetServiceClient.createBudget(request); }
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:
- 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.
- 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.
- 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);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BudgetServiceClient.ListBudgetsFixedSizeCollection
static class
BudgetServiceClient.ListBudgetsPage
static class
BudgetServiceClient.ListBudgetsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
BudgetServiceClient(BudgetServiceSettings settings)
Constructs an instance of BudgetServiceClient, using the given settings.protected
BudgetServiceClient(BudgetServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static BudgetServiceClient
create()
Constructs an instance of BudgetServiceClient with default settings.static BudgetServiceClient
create(BudgetServiceSettings settings)
Constructs an instance of BudgetServiceClient, using the given settings.static BudgetServiceClient
create(BudgetServiceStub stub)
Constructs an instance of BudgetServiceClient, using the given stub for making calls.Budget
createBudget(CreateBudgetRequest request)
Creates a new budget.com.google.api.gax.rpc.UnaryCallable<CreateBudgetRequest,Budget>
createBudgetCallable()
Creates a new budget.void
deleteBudget(DeleteBudgetRequest request)
Deletes a budget.com.google.api.gax.rpc.UnaryCallable<DeleteBudgetRequest,com.google.protobuf.Empty>
deleteBudgetCallable()
Deletes a budget.Budget
getBudget(GetBudgetRequest request)
Returns a budget.com.google.api.gax.rpc.UnaryCallable<GetBudgetRequest,Budget>
getBudgetCallable()
Returns a budget.BudgetServiceSettings
getSettings()
BudgetServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
BudgetServiceClient.ListBudgetsPagedResponse
listBudgets(ListBudgetsRequest request)
Returns a list of budgets for a billing account.com.google.api.gax.rpc.UnaryCallable<ListBudgetsRequest,ListBudgetsResponse>
listBudgetsCallable()
Returns a list of budgets for a billing account.com.google.api.gax.rpc.UnaryCallable<ListBudgetsRequest,BudgetServiceClient.ListBudgetsPagedResponse>
listBudgetsPagedCallable()
Returns a list of budgets for a billing account.void
shutdown()
void
shutdownNow()
Budget
updateBudget(UpdateBudgetRequest request)
Updates a budget and returns the updated budget.com.google.api.gax.rpc.UnaryCallable<UpdateBudgetRequest,Budget>
updateBudgetCallable()
Updates a budget and returns the updated budget.
-
-
-
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
-
BudgetServiceClient
protected BudgetServiceClient(BudgetServiceStub stub)
-
-
Method Detail
-
create
public static final BudgetServiceClient create() throws IOException
Constructs an instance of BudgetServiceClient with default settings.- Throws:
IOException
-
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).
-
getSettings
public final BudgetServiceSettings getSettings()
-
getStub
public BudgetServiceStub getStub()
-
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(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").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(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString()) .setBudget(Budget.newBuilder().build()) .build(); ApiFuture<Budget> future = budgetServiceClient.createBudgetCallable().futureCall(request); // Do something. Budget response = future.get(); }
-
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(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(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(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").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(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").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(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").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(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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-