Usageapi (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

UsageapiClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200107")
public interface Usageapi
extends AutoCloseable
```
Use the Usage API to view your Oracle Cloud usage and costs. The API allows you to request data that meets the specified filter criteria, and to group that data by the chosen dimension. The Usage API is used by the Cost Analysis and Carbon Emissions Analysis tools in the Console. See Cost Analysis Overview and Using the Usage API for more information. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateCustomTableResponse`	`createCustomTable(CreateCustomTableRequest request)` Returns the created custom table.
`CreateEmailRecipientsGroupResponse`	`createEmailRecipientsGroup(CreateEmailRecipientsGroupRequest request)` Add a list of email recipients that can receive usage statements for the subscription.
`CreateQueryResponse`	`createQuery(CreateQueryRequest request)` Returns the created query.
`CreateScheduleResponse`	`createSchedule(CreateScheduleRequest request)` Returns the created schedule.
`CreateUsageCarbonEmissionsQueryResponse`	`createUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest request)` Returns the created usage carbon emissions query.
`DeleteCustomTableResponse`	`deleteCustomTable(DeleteCustomTableRequest request)` Delete a saved custom table by the OCID.
`DeleteEmailRecipientsGroupResponse`	`deleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest request)` Delete the email recipients group for the usage statement subscription.
`DeleteQueryResponse`	`deleteQuery(DeleteQueryRequest request)` Delete a saved query by the OCID.
`DeleteScheduleResponse`	`deleteSchedule(DeleteScheduleRequest request)` Delete a saved scheduled report by the OCID.
`DeleteUsageCarbonEmissionsQueryResponse`	`deleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest request)` Delete a usage carbon emissions saved query by the OCID.
`GetCustomTableResponse`	`getCustomTable(GetCustomTableRequest request)` Returns the saved custom table.
`GetEmailRecipientsGroupResponse`	`getEmailRecipientsGroup(GetEmailRecipientsGroupRequest request)` Return the saved usage statement email recipient group.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`UsageapiPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetQueryResponse`	`getQuery(GetQueryRequest request)` Returns the saved query.
`GetScheduleResponse`	`getSchedule(GetScheduleRequest request)` Returns the saved schedule.
`GetScheduledRunResponse`	`getScheduledRun(GetScheduledRunRequest request)` Returns the saved schedule run.
`GetUsageCarbonEmissionsQueryResponse`	`getUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest request)` Returns the usage carbon emissions saved query.
`UsageapiWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListCustomTablesResponse`	`listCustomTables(ListCustomTablesRequest request)` Returns the saved custom table list.
`ListEmailRecipientsGroupsResponse`	`listEmailRecipientsGroups(ListEmailRecipientsGroupsRequest request)` Return the saved usage statement email recipient group.
`ListQueriesResponse`	`listQueries(ListQueriesRequest request)` Returns the saved query list.
`ListScheduledRunsResponse`	`listScheduledRuns(ListScheduledRunsRequest request)` Returns schedule history list.
`ListSchedulesResponse`	`listSchedules(ListSchedulesRequest request)` Returns the saved schedule list.
`ListUsageCarbonEmissionsQueriesResponse`	`listUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest request)` Returns the usage carbon emissions saved query list.
`void`	`refreshClient()` Rebuilds the client from scratch.
`RequestAverageCarbonEmissionResponse`	`requestAverageCarbonEmission(RequestAverageCarbonEmissionRequest request)` Returns the average carbon emissions summary by SKU.
`RequestCleanEnergyUsageResponse`	`requestCleanEnergyUsage(RequestCleanEnergyUsageRequest request)` Returns the clean energy usage summary by region.
`RequestSummarizedConfigurationsResponse`	`requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request)` Returns the configurations list for the UI drop-down list.
`RequestSummarizedUsagesResponse`	`requestSummarizedUsages(RequestSummarizedUsagesRequest request)` Returns usage for the given account.
`RequestUsageCarbonEmissionConfigResponse`	`requestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest request)` Returns the configuration list for the UI drop-down list of carbon emission console.
`RequestUsageCarbonEmissionsResponse`	`requestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest request)` Returns usage carbon emission for the given account.
`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’).
`UpdateCustomTableResponse`	`updateCustomTable(UpdateCustomTableRequest request)` Update a saved custom table by table id.
`UpdateEmailRecipientsGroupResponse`	`updateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest request)` Update a saved email recipients group.
`UpdateQueryResponse`	`updateQuery(UpdateQueryRequest request)` Update a saved query by the OCID.
`UpdateScheduleResponse`	`updateSchedule(UpdateScheduleRequest request)` Update a saved schedule
`UpdateUsageCarbonEmissionsQueryResponse`	`updateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest request)` Update a usage carbon emissions saved query by the OCID.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - 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.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - createCustomTable
```
CreateCustomTableResponse createCustomTable(CreateCustomTableRequest request)
```
    Returns the created custom table.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateCustomTable API.
  - createEmailRecipientsGroup
```
CreateEmailRecipientsGroupResponse createEmailRecipientsGroup(CreateEmailRecipientsGroupRequest request)
```
    Add a list of email recipients that can receive usage statements for the subscription.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateEmailRecipientsGroup API.
  - createQuery
```
CreateQueryResponse createQuery(CreateQueryRequest request)
```
    Returns the created query.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateQuery API.
  - createSchedule
```
CreateScheduleResponse createSchedule(CreateScheduleRequest request)
```
    Returns the created schedule.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateSchedule API.
  - createUsageCarbonEmissionsQuery
```
CreateUsageCarbonEmissionsQueryResponse createUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest request)
```
    Returns the created usage carbon emissions query.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateUsageCarbonEmissionsQuery API.
  - deleteCustomTable
```
DeleteCustomTableResponse deleteCustomTable(DeleteCustomTableRequest request)
```
    Delete a saved custom table 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteCustomTable API.
  - deleteEmailRecipientsGroup
```
DeleteEmailRecipientsGroupResponse deleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest request)
```
    Delete the email recipients group for the usage statement subscription.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteEmailRecipientsGroup API.
  - deleteQuery
```
DeleteQueryResponse deleteQuery(DeleteQueryRequest request)
```
    Delete a saved query 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteQuery API.
  - deleteSchedule
```
DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest request)
```
    Delete a saved scheduled report 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteSchedule API.
  - deleteUsageCarbonEmissionsQuery
```
DeleteUsageCarbonEmissionsQueryResponse deleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest request)
```
    Delete a usage carbon emissions saved query 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteUsageCarbonEmissionsQuery API.
  - getCustomTable
```
GetCustomTableResponse getCustomTable(GetCustomTableRequest request)
```
    Returns the saved custom table.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetCustomTable API.
  - getEmailRecipientsGroup
```
GetEmailRecipientsGroupResponse getEmailRecipientsGroup(GetEmailRecipientsGroupRequest request)
```
    Return the saved usage statement email recipient group.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetEmailRecipientsGroup API.
  - getQuery
```
GetQueryResponse getQuery(GetQueryRequest request)
```
    Returns the saved query.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetQuery API.
  - getSchedule
```
GetScheduleResponse getSchedule(GetScheduleRequest request)
```
    Returns the saved schedule.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetSchedule API.
  - getScheduledRun
```
GetScheduledRunResponse getScheduledRun(GetScheduledRunRequest request)
```
    Returns the saved schedule run.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetScheduledRun API.
  - getUsageCarbonEmissionsQuery
```
GetUsageCarbonEmissionsQueryResponse getUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest request)
```
    Returns the usage carbon emissions saved query.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetUsageCarbonEmissionsQuery API.
  - listCustomTables
```
ListCustomTablesResponse listCustomTables(ListCustomTablesRequest request)
```
    Returns the saved custom table list.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListCustomTables API.
  - listEmailRecipientsGroups
```
ListEmailRecipientsGroupsResponse listEmailRecipientsGroups(ListEmailRecipientsGroupsRequest request)
```
    Return the saved usage statement email recipient group.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListEmailRecipientsGroups API.
  - listQueries
```
ListQueriesResponse listQueries(ListQueriesRequest request)
```
    Returns the saved query list.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListQueries API.
  - listScheduledRuns
```
ListScheduledRunsResponse listScheduledRuns(ListScheduledRunsRequest request)
```
    Returns schedule history list.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListScheduledRuns API.
  - listSchedules
```
ListSchedulesResponse listSchedules(ListSchedulesRequest request)
```
    Returns the saved schedule list.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListSchedules API.
  - listUsageCarbonEmissionsQueries
```
ListUsageCarbonEmissionsQueriesResponse listUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest request)
```
    Returns the usage carbon emissions saved query list.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListUsageCarbonEmissionsQueries API.
  - requestAverageCarbonEmission
```
RequestAverageCarbonEmissionResponse requestAverageCarbonEmission(RequestAverageCarbonEmissionRequest request)
```
    Returns the average carbon emissions summary by SKU.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RequestAverageCarbonEmission API.
  - requestCleanEnergyUsage
```
RequestCleanEnergyUsageResponse requestCleanEnergyUsage(RequestCleanEnergyUsageRequest request)
```
    Returns the clean energy usage summary by region.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RequestCleanEnergyUsage API.
  - requestSummarizedConfigurations
```
RequestSummarizedConfigurationsResponse requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request)
```
    Returns the configurations list for the UI drop-down list.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RequestSummarizedConfigurations API.
  - requestSummarizedUsages
```
RequestSummarizedUsagesResponse requestSummarizedUsages(RequestSummarizedUsagesRequest request)
```
    Returns usage for the given account.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RequestSummarizedUsages API.
  - requestUsageCarbonEmissionConfig
```
RequestUsageCarbonEmissionConfigResponse requestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest request)
```
    Returns the configuration list for the UI drop-down list of carbon emission console.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RequestUsageCarbonEmissionConfig API.
  - requestUsageCarbonEmissions
```
RequestUsageCarbonEmissionsResponse requestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest request)
```
    Returns usage carbon emission for the given account.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use RequestUsageCarbonEmissions API.
  - updateCustomTable
```
UpdateCustomTableResponse updateCustomTable(UpdateCustomTableRequest request)
```
    Update a saved custom table by table id.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateCustomTable API.
  - updateEmailRecipientsGroup
```
UpdateEmailRecipientsGroupResponse updateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest request)
```
    Update a saved email recipients group.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateEmailRecipientsGroup API.
  - updateQuery
```
UpdateQueryResponse updateQuery(UpdateQueryRequest request)
```
    Update a saved query 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateQuery API.
  - updateSchedule
```
UpdateScheduleResponse updateSchedule(UpdateScheduleRequest request)
```
    Update a saved schedule
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateSchedule API.
  - updateUsageCarbonEmissionsQuery
```
UpdateUsageCarbonEmissionsQueryResponse updateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest request)
```
    Update a usage carbon emissions saved query 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateUsageCarbonEmissionsQuery API.
  - getWaiters
```
UsageapiWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
UsageapiPaginators 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.

Interface Usageapi

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

createCustomTable

createEmailRecipientsGroup

createQuery

createSchedule

createUsageCarbonEmissionsQuery

deleteCustomTable

deleteEmailRecipientsGroup

deleteQuery

deleteSchedule

deleteUsageCarbonEmissionsQuery

getCustomTable

getEmailRecipientsGroup

getQuery

getSchedule

getScheduledRun

getUsageCarbonEmissionsQuery

listCustomTables

listEmailRecipientsGroups

listQueries

listScheduledRuns

listSchedules

listUsageCarbonEmissionsQueries

requestAverageCarbonEmission

requestCleanEnergyUsage

requestSummarizedConfigurations

requestSummarizedUsages

requestUsageCarbonEmissionConfig

requestUsageCarbonEmissions

updateCustomTable

updateEmailRecipientsGroup

updateQuery

updateSchedule

updateUsageCarbonEmissionsQuery

getWaiters

getPaginators