BudgetClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.budget.BudgetClient

All Implemented Interfaces:: Budget, AutoCloseable

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BudgetClient.Builder
Builder class for this client.

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.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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`	`refreshClient()` Rebuilds the client from scratch.
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Budget.
- Constructor Detail
  - BudgetClient
```
public BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - BudgetClient
```
public BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - BudgetClient
```
public BudgetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - BudgetClient
```
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - BudgetClient
```
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - BudgetClient
```
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - BudgetClient
```
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - BudgetClient
```
public BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint,
                    ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - BudgetClient
```
protected BudgetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService,
                       RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the BudgetClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static BudgetClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: Budget
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface Budget
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: Budget
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface Budget
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: Budget
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface Budget
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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').
    Additional targetTypes would be available in future releases. 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.

Class BudgetClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

BudgetClient

BudgetClient

BudgetClient

BudgetClient

BudgetClient

BudgetClient

BudgetClient

BudgetClient

BudgetClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

createAlertRule

createBudget

deleteAlertRule

deleteBudget

getAlertRule

getBudget

listAlertRules

listBudgets

updateAlertRule

updateBudget

getWaiters

getPaginators