- 2.47.0 (latest)
- 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 | Product Reference |
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().
Method | Description | Method Variants |
---|---|---|
CreateBudget | Creates a new budget. See Quotas and limits 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return 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.
Static Methods
create()
public static final BudgetServiceClient create()
Constructs an instance of BudgetServiceClient with default settings.
Returns | |
---|---|
Type | Description |
BudgetServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
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 | BudgetServiceSettings |
Returns | |
---|---|
Type | Description |
BudgetServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
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 | BudgetServiceStub |
Returns | |
---|---|
Type | Description |
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 | BudgetServiceSettings |
BudgetServiceClient(BudgetServiceStub stub)
protected BudgetServiceClient(BudgetServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | BudgetServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createBudget(CreateBudgetRequest request)
public final Budget createBudget(CreateBudgetRequest request)
Creates a new budget. See Quotas and limits 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);
}
Parameter | |
---|---|
Name | Description |
request | CreateBudgetRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Budget |
createBudgetCallable()
public final UnaryCallable<CreateBudgetRequest,Budget> createBudgetCallable()
Creates a new budget. See Quotas and limits 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateBudgetRequest,Budget> |
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 | DeleteBudgetRequest The request object containing all of the parameters for the API call. |
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 |
UnaryCallable<DeleteBudgetRequest,Empty> |
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 | GetBudgetRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 |
UnaryCallable<GetBudgetRequest,Budget> |
getSettings()
public final BudgetServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
BudgetServiceSettings |
getStub()
public BudgetServiceStub getStub()
Returns | |
---|---|
Type | Description |
BudgetServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
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(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
.setScope("scope109264468")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Budget element : budgetServiceClient.listBudgets(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListBudgetsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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(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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListBudgetsRequest,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(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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListBudgetsRequest,ListBudgetsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
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 | UpdateBudgetRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 |
UnaryCallable<UpdateBudgetRequest,Budget> |