@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 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.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<CreateCustomTableResponse> createCustomTable(CreateCustomTableRequest request, AsyncHandler<CreateCustomTableRequest,CreateCustomTableResponse> handler)
Returns the created custom table.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateEmailRecipientsGroupResponse> createEmailRecipientsGroup(CreateEmailRecipientsGroupRequest request, AsyncHandler<CreateEmailRecipientsGroupRequest,CreateEmailRecipientsGroupResponse> handler)
Add a list of email recipients that can receive usage statements for the subscription.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateQueryResponse> createQuery(CreateQueryRequest request, AsyncHandler<CreateQueryRequest,CreateQueryResponse> handler)
Returns the created query.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateScheduleResponse> createSchedule(CreateScheduleRequest request, AsyncHandler<CreateScheduleRequest,CreateScheduleResponse> handler)
Returns the created schedule.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateUsageCarbonEmissionsQueryResponse> createUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest request, AsyncHandler<CreateUsageCarbonEmissionsQueryRequest,CreateUsageCarbonEmissionsQueryResponse> handler)
Returns the created usage carbon emissions query.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteCustomTableResponse> deleteCustomTable(DeleteCustomTableRequest request, AsyncHandler<DeleteCustomTableRequest,DeleteCustomTableResponse> handler)
Delete a saved custom table by the OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteEmailRecipientsGroupResponse> deleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest request, AsyncHandler<DeleteEmailRecipientsGroupRequest,DeleteEmailRecipientsGroupResponse> handler)
Delete the email recipients group for the usage statement subscription.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteQueryResponse> deleteQuery(DeleteQueryRequest request, AsyncHandler<DeleteQueryRequest,DeleteQueryResponse> handler)
Delete a saved query by the OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteScheduleResponse> deleteSchedule(DeleteScheduleRequest request, AsyncHandler<DeleteScheduleRequest,DeleteScheduleResponse> handler)
Delete a saved scheduled report by the OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteUsageCarbonEmissionsQueryResponse> deleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest request, AsyncHandler<DeleteUsageCarbonEmissionsQueryRequest,DeleteUsageCarbonEmissionsQueryResponse> handler)
Delete a usage carbon emissions saved query by the OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCustomTableResponse> getCustomTable(GetCustomTableRequest request, AsyncHandler<GetCustomTableRequest,GetCustomTableResponse> handler)
Returns the saved custom table.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetEmailRecipientsGroupResponse> getEmailRecipientsGroup(GetEmailRecipientsGroupRequest request, AsyncHandler<GetEmailRecipientsGroupRequest,GetEmailRecipientsGroupResponse> handler)
Return the saved usage statement email recipient group.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetQueryResponse> getQuery(GetQueryRequest request, AsyncHandler<GetQueryRequest,GetQueryResponse> handler)
Returns the saved query.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetScheduleResponse> getSchedule(GetScheduleRequest request, AsyncHandler<GetScheduleRequest,GetScheduleResponse> handler)
Returns the saved schedule.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetScheduledRunResponse> getScheduledRun(GetScheduledRunRequest request, AsyncHandler<GetScheduledRunRequest,GetScheduledRunResponse> handler)
Returns the saved schedule run.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetUsageCarbonEmissionsQueryResponse> getUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest request, AsyncHandler<GetUsageCarbonEmissionsQueryRequest,GetUsageCarbonEmissionsQueryResponse> handler)
Returns the usage carbon emissions saved query.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCustomTablesResponse> listCustomTables(ListCustomTablesRequest request, AsyncHandler<ListCustomTablesRequest,ListCustomTablesResponse> handler)
Returns the saved custom table list.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListEmailRecipientsGroupsResponse> listEmailRecipientsGroups(ListEmailRecipientsGroupsRequest request, AsyncHandler<ListEmailRecipientsGroupsRequest,ListEmailRecipientsGroupsResponse> handler)
Return the saved usage statement email recipient group.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListQueriesResponse> listQueries(ListQueriesRequest request, AsyncHandler<ListQueriesRequest,ListQueriesResponse> handler)
Returns the saved query list.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListScheduledRunsResponse> listScheduledRuns(ListScheduledRunsRequest request, AsyncHandler<ListScheduledRunsRequest,ListScheduledRunsResponse> handler)
Returns schedule history list.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSchedulesResponse> listSchedules(ListSchedulesRequest request, AsyncHandler<ListSchedulesRequest,ListSchedulesResponse> handler)
Returns the saved schedule list.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListUsageCarbonEmissionsQueriesResponse> listUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest request, AsyncHandler<ListUsageCarbonEmissionsQueriesRequest,ListUsageCarbonEmissionsQueriesResponse> handler)
Returns the usage carbon emissions saved query list.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RequestAverageCarbonEmissionResponse> requestAverageCarbonEmission(RequestAverageCarbonEmissionRequest request, AsyncHandler<RequestAverageCarbonEmissionRequest,RequestAverageCarbonEmissionResponse> handler)
Returns the average carbon emissions summary by SKU.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RequestCleanEnergyUsageResponse> requestCleanEnergyUsage(RequestCleanEnergyUsageRequest request, AsyncHandler<RequestCleanEnergyUsageRequest,RequestCleanEnergyUsageResponse> handler)
Returns the clean energy usage summary by region.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RequestSummarizedConfigurationsResponse> requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request, AsyncHandler<RequestSummarizedConfigurationsRequest,RequestSummarizedConfigurationsResponse> handler)
Returns the configurations list for the UI drop-down list.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RequestSummarizedUsagesResponse> requestSummarizedUsages(RequestSummarizedUsagesRequest request, AsyncHandler<RequestSummarizedUsagesRequest,RequestSummarizedUsagesResponse> handler)
Returns usage for the given account.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RequestUsageCarbonEmissionConfigResponse> requestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest request, AsyncHandler<RequestUsageCarbonEmissionConfigRequest,RequestUsageCarbonEmissionConfigResponse> handler)
Returns the configuration list for the UI drop-down list of carbon emission console.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RequestUsageCarbonEmissionsResponse> requestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest request, AsyncHandler<RequestUsageCarbonEmissionsRequest,RequestUsageCarbonEmissionsResponse> handler)
Returns usage carbon emission for the given account.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateCustomTableResponse> updateCustomTable(UpdateCustomTableRequest request, AsyncHandler<UpdateCustomTableRequest,UpdateCustomTableResponse> handler)
Update a saved custom table by table id.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateEmailRecipientsGroupResponse> updateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest request, AsyncHandler<UpdateEmailRecipientsGroupRequest,UpdateEmailRecipientsGroupResponse> handler)
Update a saved email recipients group.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateQueryResponse> updateQuery(UpdateQueryRequest request, AsyncHandler<UpdateQueryRequest,UpdateQueryResponse> handler)
Update a saved query by the OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateScheduleResponse> updateSchedule(UpdateScheduleRequest request, AsyncHandler<UpdateScheduleRequest,UpdateScheduleResponse> handler)
Update a saved schedule
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateUsageCarbonEmissionsQueryResponse> updateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest request, AsyncHandler<UpdateUsageCarbonEmissionsQueryRequest,UpdateUsageCarbonEmissionsQueryResponse> handler)
Update a usage carbon emissions saved query by the OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.