UsageapiAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

UsageapiAsyncClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200107")
public interface UsageapiAsync
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 dimension of your choosing. The Usage API is used by the Cost Analysis tool in the Console. Also see Using the Usage API for more information.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<CreateCustomTableResponse>`	`createCustomTable(CreateCustomTableRequest request, AsyncHandler<CreateCustomTableRequest,CreateCustomTableResponse> handler)` Returns the created custom table.
`Future<CreateQueryResponse>`	`createQuery(CreateQueryRequest request, AsyncHandler<CreateQueryRequest,CreateQueryResponse> handler)` Returns the created query.
`Future<CreateScheduleResponse>`	`createSchedule(CreateScheduleRequest request, AsyncHandler<CreateScheduleRequest,CreateScheduleResponse> handler)` Returns the created schedule.
`Future<DeleteCustomTableResponse>`	`deleteCustomTable(DeleteCustomTableRequest request, AsyncHandler<DeleteCustomTableRequest,DeleteCustomTableResponse> handler)` Delete a saved custom table by the OCID.
`Future<DeleteQueryResponse>`	`deleteQuery(DeleteQueryRequest request, AsyncHandler<DeleteQueryRequest,DeleteQueryResponse> handler)` Delete a saved query by the OCID.
`Future<DeleteScheduleResponse>`	`deleteSchedule(DeleteScheduleRequest request, AsyncHandler<DeleteScheduleRequest,DeleteScheduleResponse> handler)` Delete a saved scheduled report by the OCID.
`Future<GetCustomTableResponse>`	`getCustomTable(GetCustomTableRequest request, AsyncHandler<GetCustomTableRequest,GetCustomTableResponse> handler)` Returns the saved custom table.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<GetQueryResponse>`	`getQuery(GetQueryRequest request, AsyncHandler<GetQueryRequest,GetQueryResponse> handler)` Returns the saved query.
`Future<GetScheduleResponse>`	`getSchedule(GetScheduleRequest request, AsyncHandler<GetScheduleRequest,GetScheduleResponse> handler)` Returns the saved schedule.
`Future<GetScheduledRunResponse>`	`getScheduledRun(GetScheduledRunRequest request, AsyncHandler<GetScheduledRunRequest,GetScheduledRunResponse> handler)` Returns the saved schedule run.
`Future<ListCustomTablesResponse>`	`listCustomTables(ListCustomTablesRequest request, AsyncHandler<ListCustomTablesRequest,ListCustomTablesResponse> handler)` Returns the saved custom table list.
`Future<ListQueriesResponse>`	`listQueries(ListQueriesRequest request, AsyncHandler<ListQueriesRequest,ListQueriesResponse> handler)` Returns the saved query list.
`Future<ListScheduledRunsResponse>`	`listScheduledRuns(ListScheduledRunsRequest request, AsyncHandler<ListScheduledRunsRequest,ListScheduledRunsResponse> handler)` Returns schedule history list.
`Future<ListSchedulesResponse>`	`listSchedules(ListSchedulesRequest request, AsyncHandler<ListSchedulesRequest,ListSchedulesResponse> handler)` Returns the saved schedule list.
`void`	`refreshClient()` Rebuilds the client from scratch.
`Future<RequestSummarizedConfigurationsResponse>`	`requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request, AsyncHandler<RequestSummarizedConfigurationsRequest,RequestSummarizedConfigurationsResponse> handler)` Returns the configurations list for the UI drop-down list.
`Future<RequestSummarizedUsagesResponse>`	`requestSummarizedUsages(RequestSummarizedUsagesRequest request, AsyncHandler<RequestSummarizedUsagesRequest,RequestSummarizedUsagesResponse> handler)` Returns usage 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’).
`Future<UpdateCustomTableResponse>`	`updateCustomTable(UpdateCustomTableRequest request, AsyncHandler<UpdateCustomTableRequest,UpdateCustomTableResponse> handler)` Update a saved custom table by table id.
`Future<UpdateQueryResponse>`	`updateQuery(UpdateQueryRequest request, AsyncHandler<UpdateQueryRequest,UpdateQueryResponse> handler)` Update a saved query by the OCID.
`Future<UpdateScheduleResponse>`	`updateSchedule(UpdateScheduleRequest request, AsyncHandler<UpdateScheduleRequest,UpdateScheduleResponse> handler)` Update a saved schedule
`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 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.
  - 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
```
Future<CreateCustomTableResponse> createCustomTable(CreateCustomTableRequest request,
                                                    AsyncHandler<CreateCustomTableRequest,CreateCustomTableResponse> handler)
```
    Returns the created custom table.
    
    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.
  - createQuery
```
Future<CreateQueryResponse> createQuery(CreateQueryRequest request,
                                        AsyncHandler<CreateQueryRequest,CreateQueryResponse> handler)
```
    Returns the created query.
    
    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.
  - createSchedule
```
Future<CreateScheduleResponse> createSchedule(CreateScheduleRequest request,
                                              AsyncHandler<CreateScheduleRequest,CreateScheduleResponse> handler)
```
    Returns the created schedule.
    
    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.
  - deleteCustomTable
```
Future<DeleteCustomTableResponse> deleteCustomTable(DeleteCustomTableRequest request,
                                                    AsyncHandler<DeleteCustomTableRequest,DeleteCustomTableResponse> handler)
```
    Delete a saved custom table 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.
  - deleteQuery
```
Future<DeleteQueryResponse> deleteQuery(DeleteQueryRequest request,
                                        AsyncHandler<DeleteQueryRequest,DeleteQueryResponse> handler)
```
    Delete a saved query 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.
  - deleteSchedule
```
Future<DeleteScheduleResponse> deleteSchedule(DeleteScheduleRequest request,
                                              AsyncHandler<DeleteScheduleRequest,DeleteScheduleResponse> handler)
```
    Delete a saved scheduled report 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.
  - getCustomTable
```
Future<GetCustomTableResponse> getCustomTable(GetCustomTableRequest request,
                                              AsyncHandler<GetCustomTableRequest,GetCustomTableResponse> handler)
```
    Returns the saved custom table.
    
    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.
  - getQuery
```
Future<GetQueryResponse> getQuery(GetQueryRequest request,
                                  AsyncHandler<GetQueryRequest,GetQueryResponse> handler)
```
    Returns the saved query.
    
    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.
  - getSchedule
```
Future<GetScheduleResponse> getSchedule(GetScheduleRequest request,
                                        AsyncHandler<GetScheduleRequest,GetScheduleResponse> handler)
```
    Returns the saved schedule.
    
    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.
  - getScheduledRun
```
Future<GetScheduledRunResponse> getScheduledRun(GetScheduledRunRequest request,
                                                AsyncHandler<GetScheduledRunRequest,GetScheduledRunResponse> handler)
```
    Returns the saved schedule run.
    
    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.
  - listCustomTables
```
Future<ListCustomTablesResponse> listCustomTables(ListCustomTablesRequest request,
                                                  AsyncHandler<ListCustomTablesRequest,ListCustomTablesResponse> handler)
```
    Returns the saved custom table list.
    
    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.
  - listQueries
```
Future<ListQueriesResponse> listQueries(ListQueriesRequest request,
                                        AsyncHandler<ListQueriesRequest,ListQueriesResponse> handler)
```
    Returns the saved query list.
    
    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.
  - listScheduledRuns
```
Future<ListScheduledRunsResponse> listScheduledRuns(ListScheduledRunsRequest request,
                                                    AsyncHandler<ListScheduledRunsRequest,ListScheduledRunsResponse> handler)
```
    Returns schedule history list.
    
    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.
  - listSchedules
```
Future<ListSchedulesResponse> listSchedules(ListSchedulesRequest request,
                                            AsyncHandler<ListSchedulesRequest,ListSchedulesResponse> handler)
```
    Returns the saved schedule list.
    
    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.
  - requestSummarizedConfigurations
```
Future<RequestSummarizedConfigurationsResponse> requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request,
                                                                                AsyncHandler<RequestSummarizedConfigurationsRequest,RequestSummarizedConfigurationsResponse> handler)
```
    Returns the configurations list for the UI drop-down list.
    
    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.
  - requestSummarizedUsages
```
Future<RequestSummarizedUsagesResponse> requestSummarizedUsages(RequestSummarizedUsagesRequest request,
                                                                AsyncHandler<RequestSummarizedUsagesRequest,RequestSummarizedUsagesResponse> handler)
```
    Returns usage for the given account.
    
    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.
  - updateCustomTable
```
Future<UpdateCustomTableResponse> updateCustomTable(UpdateCustomTableRequest request,
                                                    AsyncHandler<UpdateCustomTableRequest,UpdateCustomTableResponse> handler)
```
    Update a saved custom table by table id.
    
    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.
  - updateQuery
```
Future<UpdateQueryResponse> updateQuery(UpdateQueryRequest request,
                                        AsyncHandler<UpdateQueryRequest,UpdateQueryResponse> handler)
```
    Update a saved query 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.
  - updateSchedule
```
Future<UpdateScheduleResponse> updateSchedule(UpdateScheduleRequest request,
                                              AsyncHandler<UpdateScheduleRequest,UpdateScheduleResponse> handler)
```
    Update a saved schedule
    
    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 UsageapiAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

createCustomTable

createQuery

createSchedule

deleteCustomTable

deleteQuery

deleteSchedule

getCustomTable

getQuery

getSchedule

getScheduledRun

listCustomTables

listQueries

listScheduledRuns

listSchedules

requestSummarizedConfigurations

requestSummarizedUsages

updateCustomTable

updateQuery

updateSchedule