com.oracle.bmc.budget

Interface Budget

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BudgetClient

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

Method Summary

Modifier and Type	Method and Description
CreateAlertRuleResponse	createAlertRule(CreateAlertRuleRequest request) Creates a new Alert Rule.
CreateBudgetResponse	createBudget(CreateBudgetRequest request) Creates a new Budget.
DeleteAlertRuleResponse	deleteAlertRule(DeleteAlertRuleRequest request) Deletes a specified Alert Rule resource.
DeleteBudgetResponse	deleteBudget(DeleteBudgetRequest request) Deletes a specified Budget resource
GetAlertRuleResponse	getAlertRule(GetAlertRuleRequest request) Gets an Alert Rule for a specified Budget.
GetBudgetResponse	getBudget(GetBudgetRequest request) Gets a Budget by identifier
BudgetPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
BudgetWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListAlertRulesResponse	listAlertRules(ListAlertRulesRequest request) Returns a list of Alert Rules for a specified Budget.
ListBudgetsResponse	listBudgets(ListBudgetsRequest request) 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’).
UpdateAlertRuleResponse	updateAlertRule(UpdateAlertRuleRequest request) Update an Alert Rule for the budget identified by the OCID.
UpdateBudgetResponse	updateBudget(UpdateBudgetRequest request) 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 service.

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

CreateAlertRuleResponse createAlertRule(CreateAlertRuleRequest request)

Creates a new Alert Rule.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

createBudget

CreateBudgetResponse createBudget(CreateBudgetRequest request)

Creates a new Budget.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteAlertRule

DeleteAlertRuleResponse deleteAlertRule(DeleteAlertRuleRequest request)

Deletes a specified Alert Rule resource.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteBudget

DeleteBudgetResponse deleteBudget(DeleteBudgetRequest request)

Deletes a specified Budget resource

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getAlertRule

GetAlertRuleResponse getAlertRule(GetAlertRuleRequest request)

Gets an Alert Rule for a specified Budget.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getBudget

GetBudgetResponse getBudget(GetBudgetRequest request)

Gets a Budget by identifier

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

listAlertRules

ListAlertRulesResponse listAlertRules(ListAlertRulesRequest request)

Returns a list of Alert Rules for a specified Budget.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

listBudgets

ListBudgetsResponse listBudgets(ListBudgetsRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateAlertRule

UpdateAlertRuleResponse updateAlertRule(UpdateAlertRuleRequest request)

Update an Alert Rule for the budget identified by the OCID.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateBudget

UpdateBudgetResponse updateBudget(UpdateBudgetRequest request)

Update a Budget identified by the OCID

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getWaiters

BudgetWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

BudgetPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.