@Generated(value="OracleSDKGenerator", comments="API Version: 20190111") public interface BudgetAsync extends AutoCloseable
Use the Budgets API to manage budgets and budget alerts.
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.Future<CreateAlertRuleResponse> createAlertRule(CreateAlertRuleRequest request, AsyncHandler<CreateAlertRuleRequest,CreateAlertRuleResponse> handler)
Creates a new Alert Rule.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateBudgetResponse> createBudget(CreateBudgetRequest request, AsyncHandler<CreateBudgetRequest,CreateBudgetResponse> handler)
Creates a new Budget.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteAlertRuleResponse> deleteAlertRule(DeleteAlertRuleRequest request, AsyncHandler<DeleteAlertRuleRequest,DeleteAlertRuleResponse> handler)
Deletes a specified Alert Rule resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteBudgetResponse> deleteBudget(DeleteBudgetRequest request, AsyncHandler<DeleteBudgetRequest,DeleteBudgetResponse> handler)
Deletes a specified Budget resource
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAlertRuleResponse> getAlertRule(GetAlertRuleRequest request, AsyncHandler<GetAlertRuleRequest,GetAlertRuleResponse> handler)
Gets an Alert Rule for a specified Budget.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetBudgetResponse> getBudget(GetBudgetRequest request, AsyncHandler<GetBudgetRequest,GetBudgetResponse> handler)
Gets a Budget by identifier
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAlertRulesResponse> listAlertRules(ListAlertRulesRequest request, AsyncHandler<ListAlertRulesRequest,ListAlertRulesResponse> handler)
Returns a list of Alert Rules for a specified Budget.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListBudgetsResponse> listBudgets(ListBudgetsRequest request, AsyncHandler<ListBudgetsRequest,ListBudgetsResponse> handler)
Gets a list of Budgets in a compartment.
By default, ListBudgets returns budgets of 'COMPARTMENT' target type and the budget records with only ONE target compartment OCID.
To list ALL budgets, set the targetType query parameter to ALL. Example: 'targetType=ALL'
Additional targetTypes would be available in future releases. Clients should ignore new targetType or upgrade to latest version of client SDK to handle new targetType.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateAlertRuleResponse> updateAlertRule(UpdateAlertRuleRequest request, AsyncHandler<UpdateAlertRuleRequest,UpdateAlertRuleResponse> handler)
Update an Alert Rule for the budget identified by the OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateBudgetResponse> updateBudget(UpdateBudgetRequest request, AsyncHandler<UpdateBudgetRequest,UpdateBudgetResponse> handler)
Update a Budget identified by the OCID
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2021. All rights reserved.