BudgetAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:: AutoCloseable

All Known Implementing Classes:: BudgetAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public interface BudgetAsync
extends AutoCloseable

Use the Budgets API to manage budgets and budget alerts.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<CreateAlertRuleResponse>`	`createAlertRule(CreateAlertRuleRequest request, AsyncHandler<CreateAlertRuleRequest,CreateAlertRuleResponse> handler)` Creates a new Alert Rule.
`Future<CreateBudgetResponse>`	`createBudget(CreateBudgetRequest request, AsyncHandler<CreateBudgetRequest,CreateBudgetResponse> handler)` Creates a new Budget.
`Future<DeleteAlertRuleResponse>`	`deleteAlertRule(DeleteAlertRuleRequest request, AsyncHandler<DeleteAlertRuleRequest,DeleteAlertRuleResponse> handler)` Deletes a specified Alert Rule resource.
`Future<DeleteBudgetResponse>`	`deleteBudget(DeleteBudgetRequest request, AsyncHandler<DeleteBudgetRequest,DeleteBudgetResponse> handler)` Deletes a specified Budget resource
`Future<GetAlertRuleResponse>`	`getAlertRule(GetAlertRuleRequest request, AsyncHandler<GetAlertRuleRequest,GetAlertRuleResponse> handler)` Gets an Alert Rule for a specified Budget.
`Future<GetBudgetResponse>`	`getBudget(GetBudgetRequest request, AsyncHandler<GetBudgetRequest,GetBudgetResponse> handler)` Gets a Budget by identifier
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<ListAlertRulesResponse>`	`listAlertRules(ListAlertRulesRequest request, AsyncHandler<ListAlertRulesRequest,ListAlertRulesResponse> handler)` Returns a list of Alert Rules for a specified Budget.
`Future<ListBudgetsResponse>`	`listBudgets(ListBudgetsRequest request, AsyncHandler<ListBudgetsRequest,ListBudgetsResponse> handler)` Gets a list of Budgets in a compartment.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`Future<UpdateAlertRuleResponse>`	`updateAlertRule(UpdateAlertRuleRequest request, AsyncHandler<UpdateAlertRuleRequest,UpdateAlertRuleResponse> handler)` Update an Alert Rule for the budget identified by the OCID.
`Future<UpdateBudgetResponse>`	`updateBudget(UpdateBudgetRequest request, AsyncHandler<UpdateBudgetRequest,UpdateBudgetResponse> handler)` Update a Budget identified by the OCID

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
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.
    
    Parameters:
    
    regionId - The public region ID.
  - createAlertRule
```
Future<CreateAlertRuleResponse> createAlertRule(CreateAlertRuleRequest request,
                                                AsyncHandler<CreateAlertRuleRequest,CreateAlertRuleResponse> handler)
```
    Creates a new Alert Rule.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createBudget
```
Future<CreateBudgetResponse> createBudget(CreateBudgetRequest request,
                                          AsyncHandler<CreateBudgetRequest,CreateBudgetResponse> handler)
```
    Creates a new Budget.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteAlertRule
```
Future<DeleteAlertRuleResponse> deleteAlertRule(DeleteAlertRuleRequest request,
                                                AsyncHandler<DeleteAlertRuleRequest,DeleteAlertRuleResponse> handler)
```
    Deletes a specified Alert Rule resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteBudget
```
Future<DeleteBudgetResponse> deleteBudget(DeleteBudgetRequest request,
                                          AsyncHandler<DeleteBudgetRequest,DeleteBudgetResponse> handler)
```
    Deletes a specified Budget resource
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getAlertRule
```
Future<GetAlertRuleResponse> getAlertRule(GetAlertRuleRequest request,
                                          AsyncHandler<GetAlertRuleRequest,GetAlertRuleResponse> handler)
```
    Gets an Alert Rule for a specified Budget.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getBudget
```
Future<GetBudgetResponse> getBudget(GetBudgetRequest request,
                                    AsyncHandler<GetBudgetRequest,GetBudgetResponse> handler)
```
    Gets a Budget by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listAlertRules
```
Future<ListAlertRulesResponse> listAlertRules(ListAlertRulesRequest request,
                                              AsyncHandler<ListAlertRulesRequest,ListAlertRulesResponse> handler)
```
    Returns a list of Alert Rules for a specified Budget.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listBudgets
```
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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateAlertRule
```
Future<UpdateAlertRuleResponse> updateAlertRule(UpdateAlertRuleRequest request,
                                                AsyncHandler<UpdateAlertRuleRequest,UpdateAlertRuleResponse> handler)
```
    Update an Alert Rule for the budget identified by the OCID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateBudget
```
Future<UpdateBudgetResponse> updateBudget(UpdateBudgetRequest request,
                                          AsyncHandler<UpdateBudgetRequest,UpdateBudgetResponse> handler)
```
    Update a Budget identified by the OCID
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

Interface BudgetAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

setEndpoint

getEndpoint

setRegion

setRegion

createAlertRule

createBudget

deleteAlertRule

deleteBudget

getAlertRule

getBudget

listAlertRules

listBudgets

updateAlertRule

updateBudget