com.oracle.bmc.budget

Class BudgetClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.budget.BudgetClient

All Implemented Interfaces:

Budget, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public class BudgetClient
extends BaseSyncClient
implements Budget

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BudgetClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for Budget.

Constructor Summary

Constructors

Constructor and Description
BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static BudgetClient.Builder	builder() Create a builder for this client.
void	close()
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 the identifier.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateBudgetResponse	updateBudget(UpdateBudgetRequest request) Update a budget identified by the OCID.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.budget.Budget

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Budget.

Constructor Detail

BudgetClient

@Deprecated
public BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

BudgetClient

@Deprecated
public BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

BudgetClient

@Deprecated
public BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

BudgetClient

@Deprecated
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

BudgetClient

@Deprecated
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

BudgetClient

@Deprecated
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

BudgetClient

@Deprecated
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

BudgetClient

@Deprecated
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint,
                                ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BudgetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - BudgetClient.Builder.executorService

Method Detail

builder

public static BudgetClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Budget

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.

Specified by:

setRegion in interface Budget

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Budget

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.

Specified by:

setRegion in interface Budget

Parameters:

regionId - The public region ID.

createAlertRule

public CreateAlertRuleResponse createAlertRule(CreateAlertRuleRequest request)

Description copied from interface: Budget

Creates a new Alert Rule.

Specified by:

createAlertRule in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createBudget

public CreateBudgetResponse createBudget(CreateBudgetRequest request)

Description copied from interface: Budget

Creates a new budget.

Specified by:

createBudget in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAlertRule

public DeleteAlertRuleResponse deleteAlertRule(DeleteAlertRuleRequest request)

Description copied from interface: Budget

Deletes a specified Alert Rule resource.

Specified by:

deleteAlertRule in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteBudget

public DeleteBudgetResponse deleteBudget(DeleteBudgetRequest request)

Description copied from interface: Budget

Deletes a specified budget resource.

Specified by:

deleteBudget in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAlertRule

public GetAlertRuleResponse getAlertRule(GetAlertRuleRequest request)

Description copied from interface: Budget

Gets an Alert Rule for a specified budget.

Specified by:

getAlertRule in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBudget

public GetBudgetResponse getBudget(GetBudgetRequest request)

Description copied from interface: Budget

Gets a budget by the identifier.

Specified by:

getBudget in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAlertRules

public ListAlertRulesResponse listAlertRules(ListAlertRulesRequest request)

Description copied from interface: Budget

Returns a list of Alert Rules for a specified budget.

Specified by:

listAlertRules in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBudgets

public ListBudgetsResponse listBudgets(ListBudgetsRequest request)

Description copied from interface: Budget

Gets a list of budgets in a compartment.

By default, ListBudgets returns budgets of the 'COMPARTMENT' target type, and the budget records with only one target compartment OCID.

To list all budgets, set the targetType query parameter to ALL (for example: 'targetType=ALL').

Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.

Specified by:

listBudgets in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAlertRule

public UpdateAlertRuleResponse updateAlertRule(UpdateAlertRuleRequest request)

Description copied from interface: Budget

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

Specified by:

updateAlertRule in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateBudget

public UpdateBudgetResponse updateBudget(UpdateBudgetRequest request)

Description copied from interface: Budget

Update a budget identified by the OCID.

Specified by:

updateBudget in interface Budget

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public BudgetWaiters getWaiters()

Description copied from interface: Budget

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

Specified by:

getWaiters in interface Budget

Returns:

The service waiters.

getPaginators

public BudgetPaginators getPaginators()

Description copied from interface: Budget

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.

Specified by:

getPaginators in interface Budget

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable