Class UsageapiAsyncClient
- java.lang.Object
- 
- com.oracle.bmc.http.internal.BaseAsyncClient
- 
- com.oracle.bmc.usageapi.UsageapiAsyncClient
 
 
- 
- All Implemented Interfaces:
- UsageapiAsync,- AutoCloseable
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20200107") public class UsageapiAsyncClient extends BaseAsyncClient implements UsageapiAsyncAsync client implementation for Usageapi service.
 There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
 2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
 Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
 Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classUsageapiAsyncClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Usageapi.
 - 
Constructor SummaryConstructors Constructor Description UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.UsageapiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.UsageapiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.UsageapiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method Summary- 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.usageapi.UsageapiAsyncgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
UsageapiAsyncClient@Deprecated public UsageapiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- UsageapiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
UsageapiAsyncClient@Deprecated public UsageapiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- UsageapiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
UsageapiAsyncClient@Deprecated public UsageapiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- UsageapiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
 
 - 
UsageapiAsyncClient@Deprecated public UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- UsageapiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
 
 - 
UsageapiAsyncClient@Deprecated public UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- UsageapiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
 
 - 
UsageapiAsyncClient@Deprecated public UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- UsageapiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
 
 - 
UsageapiAsyncClient@Deprecated public UsageapiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- UsageapiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
- endpoint-- ClientBuilderBase.endpoint(java.lang.String)
- signingStrategyRequestSignerFactories-- ClientBuilderBase.signingStrategyRequestSignerFactories
 
 
- 
 - 
Method Detail- 
builderpublic static UsageapiAsyncClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:UsageapiAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
- setRegionin interface- UsageapiAsync
- Parameters:
- region- The region of the service.
 
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:UsageapiAsyncSets 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 callsetEndpoint.- Specified by:
- setRegionin interface- UsageapiAsync
- Parameters:
- regionId- The public region ID.
 
 - 
createCustomTablepublic Future<CreateCustomTableResponse> createCustomTable(CreateCustomTableRequest request, AsyncHandler<CreateCustomTableRequest,CreateCustomTableResponse> handler) Description copied from interface:UsageapiAsyncReturns the created custom table.- Specified by:
- createCustomTablein interface- UsageapiAsync
- 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.
 
 - 
createEmailRecipientsGrouppublic Future<CreateEmailRecipientsGroupResponse> createEmailRecipientsGroup(CreateEmailRecipientsGroupRequest request, AsyncHandler<CreateEmailRecipientsGroupRequest,CreateEmailRecipientsGroupResponse> handler) Description copied from interface:UsageapiAsyncCreates a list of email recipients that can receive usage statements for the subscription.- Specified by:
- createEmailRecipientsGroupin interface- UsageapiAsync
- 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.
 
 - 
createQuerypublic Future<CreateQueryResponse> createQuery(CreateQueryRequest request, AsyncHandler<CreateQueryRequest,CreateQueryResponse> handler) Description copied from interface:UsageapiAsyncReturns the created query.- Specified by:
- createQueryin interface- UsageapiAsync
- 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.
 
 - 
createSchedulepublic Future<CreateScheduleResponse> createSchedule(CreateScheduleRequest request, AsyncHandler<CreateScheduleRequest,CreateScheduleResponse> handler) Description copied from interface:UsageapiAsyncReturns the created schedule.- Specified by:
- createSchedulein interface- UsageapiAsync
- 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.
 
 - 
createUsageCarbonEmissionsQuerypublic Future<CreateUsageCarbonEmissionsQueryResponse> createUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest request, AsyncHandler<CreateUsageCarbonEmissionsQueryRequest,CreateUsageCarbonEmissionsQueryResponse> handler) Description copied from interface:UsageapiAsyncReturns the created carbon emissions usage query.- Specified by:
- createUsageCarbonEmissionsQueryin interface- UsageapiAsync
- 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.
 
 - 
deleteCustomTablepublic Future<DeleteCustomTableResponse> deleteCustomTable(DeleteCustomTableRequest request, AsyncHandler<DeleteCustomTableRequest,DeleteCustomTableResponse> handler) Description copied from interface:UsageapiAsyncDelete a saved custom table by the OCID.- Specified by:
- deleteCustomTablein interface- UsageapiAsync
- 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.
 
 - 
deleteEmailRecipientsGrouppublic Future<DeleteEmailRecipientsGroupResponse> deleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest request, AsyncHandler<DeleteEmailRecipientsGroupRequest,DeleteEmailRecipientsGroupResponse> handler) Description copied from interface:UsageapiAsyncDeletes the email recipients group for the usage statement subscription.- Specified by:
- deleteEmailRecipientsGroupin interface- UsageapiAsync
- 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.
 
 - 
deleteQuerypublic Future<DeleteQueryResponse> deleteQuery(DeleteQueryRequest request, AsyncHandler<DeleteQueryRequest,DeleteQueryResponse> handler) Description copied from interface:UsageapiAsyncDelete a saved query by the OCID.- Specified by:
- deleteQueryin interface- UsageapiAsync
- 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.
 
 - 
deleteSchedulepublic Future<DeleteScheduleResponse> deleteSchedule(DeleteScheduleRequest request, AsyncHandler<DeleteScheduleRequest,DeleteScheduleResponse> handler) Description copied from interface:UsageapiAsyncDelete a saved scheduled report by the OCID.- Specified by:
- deleteSchedulein interface- UsageapiAsync
- 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.
 
 - 
deleteUsageCarbonEmissionsQuerypublic Future<DeleteUsageCarbonEmissionsQueryResponse> deleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest request, AsyncHandler<DeleteUsageCarbonEmissionsQueryRequest,DeleteUsageCarbonEmissionsQueryResponse> handler) Description copied from interface:UsageapiAsyncDelete a carbon emissions usage saved query by the OCID.- Specified by:
- deleteUsageCarbonEmissionsQueryin interface- UsageapiAsync
- 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.
 
 - 
getCustomTablepublic Future<GetCustomTableResponse> getCustomTable(GetCustomTableRequest request, AsyncHandler<GetCustomTableRequest,GetCustomTableResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved custom table.- Specified by:
- getCustomTablein interface- UsageapiAsync
- 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.
 
 - 
getEmailRecipientsGrouppublic Future<GetEmailRecipientsGroupResponse> getEmailRecipientsGroup(GetEmailRecipientsGroupRequest request, AsyncHandler<GetEmailRecipientsGroupRequest,GetEmailRecipientsGroupResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved usage statement email recipients group.- Specified by:
- getEmailRecipientsGroupin interface- UsageapiAsync
- 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.
 
 - 
getQuerypublic Future<GetQueryResponse> getQuery(GetQueryRequest request, AsyncHandler<GetQueryRequest,GetQueryResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved query.- Specified by:
- getQueryin interface- UsageapiAsync
- 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.
 
 - 
getSchedulepublic Future<GetScheduleResponse> getSchedule(GetScheduleRequest request, AsyncHandler<GetScheduleRequest,GetScheduleResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved schedule.- Specified by:
- getSchedulein interface- UsageapiAsync
- 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.
 
 - 
getScheduledRunpublic Future<GetScheduledRunResponse> getScheduledRun(GetScheduledRunRequest request, AsyncHandler<GetScheduledRunRequest,GetScheduledRunResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved schedule run.- Specified by:
- getScheduledRunin interface- UsageapiAsync
- 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.
 
 - 
getUsageCarbonEmissionsQuerypublic Future<GetUsageCarbonEmissionsQueryResponse> getUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest request, AsyncHandler<GetUsageCarbonEmissionsQueryRequest,GetUsageCarbonEmissionsQueryResponse> handler) Description copied from interface:UsageapiAsyncReturns the carbon emissions usage saved query.- Specified by:
- getUsageCarbonEmissionsQueryin interface- UsageapiAsync
- 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.
 
 - 
listCustomTablespublic Future<ListCustomTablesResponse> listCustomTables(ListCustomTablesRequest request, AsyncHandler<ListCustomTablesRequest,ListCustomTablesResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved custom table list.- Specified by:
- listCustomTablesin interface- UsageapiAsync
- 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.
 
 - 
listEmailRecipientsGroupspublic Future<ListEmailRecipientsGroupsResponse> listEmailRecipientsGroups(ListEmailRecipientsGroupsRequest request, AsyncHandler<ListEmailRecipientsGroupsRequest,ListEmailRecipientsGroupsResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved usage statement email recipients group.- Specified by:
- listEmailRecipientsGroupsin interface- UsageapiAsync
- 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.
 
 - 
listQueriespublic Future<ListQueriesResponse> listQueries(ListQueriesRequest request, AsyncHandler<ListQueriesRequest,ListQueriesResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved query list.- Specified by:
- listQueriesin interface- UsageapiAsync
- 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.
 
 - 
listScheduledRunspublic Future<ListScheduledRunsResponse> listScheduledRuns(ListScheduledRunsRequest request, AsyncHandler<ListScheduledRunsRequest,ListScheduledRunsResponse> handler) Description copied from interface:UsageapiAsyncReturns the schedule history list.- Specified by:
- listScheduledRunsin interface- UsageapiAsync
- 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.
 
 - 
listSchedulespublic Future<ListSchedulesResponse> listSchedules(ListSchedulesRequest request, AsyncHandler<ListSchedulesRequest,ListSchedulesResponse> handler) Description copied from interface:UsageapiAsyncReturns the saved schedule list.- Specified by:
- listSchedulesin interface- UsageapiAsync
- 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.
 
 - 
listUsageCarbonEmissionsQueriespublic Future<ListUsageCarbonEmissionsQueriesResponse> listUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest request, AsyncHandler<ListUsageCarbonEmissionsQueriesRequest,ListUsageCarbonEmissionsQueriesResponse> handler) Description copied from interface:UsageapiAsyncReturns the carbon emissions usage saved query list.- Specified by:
- listUsageCarbonEmissionsQueriesin interface- UsageapiAsync
- 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.
 
 - 
requestAverageCarbonEmissionpublic Future<RequestAverageCarbonEmissionResponse> requestAverageCarbonEmission(RequestAverageCarbonEmissionRequest request, AsyncHandler<RequestAverageCarbonEmissionRequest,RequestAverageCarbonEmissionResponse> handler) Description copied from interface:UsageapiAsyncReturns the average carbon emissions summary by SKU.- Specified by:
- requestAverageCarbonEmissionin interface- UsageapiAsync
- 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.
 
 - 
requestCleanEnergyUsagepublic Future<RequestCleanEnergyUsageResponse> requestCleanEnergyUsage(RequestCleanEnergyUsageRequest request, AsyncHandler<RequestCleanEnergyUsageRequest,RequestCleanEnergyUsageResponse> handler) Description copied from interface:UsageapiAsyncReturns the clean energy usage summary by region.- Specified by:
- requestCleanEnergyUsagein interface- UsageapiAsync
- 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.
 
 - 
requestSummarizedConfigurationspublic Future<RequestSummarizedConfigurationsResponse> requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request, AsyncHandler<RequestSummarizedConfigurationsRequest,RequestSummarizedConfigurationsResponse> handler) Description copied from interface:UsageapiAsyncReturns the configurations list for the UI drop-down list.- Specified by:
- requestSummarizedConfigurationsin interface- UsageapiAsync
- 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.
 
 - 
requestSummarizedUsagespublic Future<RequestSummarizedUsagesResponse> requestSummarizedUsages(RequestSummarizedUsagesRequest request, AsyncHandler<RequestSummarizedUsagesRequest,RequestSummarizedUsagesResponse> handler) Description copied from interface:UsageapiAsyncReturns usage for the given account.- Specified by:
- requestSummarizedUsagesin interface- UsageapiAsync
- 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.
 
 - 
requestUsageCarbonEmissionConfigpublic Future<RequestUsageCarbonEmissionConfigResponse> requestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest request, AsyncHandler<RequestUsageCarbonEmissionConfigRequest,RequestUsageCarbonEmissionConfigResponse> handler) Description copied from interface:UsageapiAsyncReturns the configuration list for the Console’s carbon emission user interface drop-down list.- Specified by:
- requestUsageCarbonEmissionConfigin interface- UsageapiAsync
- 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.
 
 - 
requestUsageCarbonEmissionspublic Future<RequestUsageCarbonEmissionsResponse> requestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest request, AsyncHandler<RequestUsageCarbonEmissionsRequest,RequestUsageCarbonEmissionsResponse> handler) Description copied from interface:UsageapiAsyncReturns carbon emission usage for the given account.- Specified by:
- requestUsageCarbonEmissionsin interface- UsageapiAsync
- 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.
 
 - 
updateCustomTablepublic Future<UpdateCustomTableResponse> updateCustomTable(UpdateCustomTableRequest request, AsyncHandler<UpdateCustomTableRequest,UpdateCustomTableResponse> handler) Description copied from interface:UsageapiAsyncUpdate a saved custom table by table ID.- Specified by:
- updateCustomTablein interface- UsageapiAsync
- 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.
 
 - 
updateEmailRecipientsGrouppublic Future<UpdateEmailRecipientsGroupResponse> updateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest request, AsyncHandler<UpdateEmailRecipientsGroupRequest,UpdateEmailRecipientsGroupResponse> handler) Description copied from interface:UsageapiAsyncUpdates a saved email recipients group.- Specified by:
- updateEmailRecipientsGroupin interface- UsageapiAsync
- 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.
 
 - 
updateQuerypublic Future<UpdateQueryResponse> updateQuery(UpdateQueryRequest request, AsyncHandler<UpdateQueryRequest,UpdateQueryResponse> handler) Description copied from interface:UsageapiAsyncUpdate a saved query by the OCID.- Specified by:
- updateQueryin interface- UsageapiAsync
- 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.
 
 - 
updateSchedulepublic Future<UpdateScheduleResponse> updateSchedule(UpdateScheduleRequest request, AsyncHandler<UpdateScheduleRequest,UpdateScheduleResponse> handler) Description copied from interface:UsageapiAsyncUpdate a saved schedule.- Specified by:
- updateSchedulein interface- UsageapiAsync
- 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.
 
 - 
updateUsageCarbonEmissionsQuerypublic Future<UpdateUsageCarbonEmissionsQueryResponse> updateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest request, AsyncHandler<UpdateUsageCarbonEmissionsQueryRequest,UpdateUsageCarbonEmissionsQueryResponse> handler) Description copied from interface:UsageapiAsyncUpdate a carbon emissions usage saved query by the OCID.- Specified by:
- updateUsageCarbonEmissionsQueryin interface- UsageapiAsync
- 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.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false - Parameters:
- useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
 
 - 
populateServiceParametersInEndpointpublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank. - Parameters:
- endpoint- The endpoint template in use
- requiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
 
 - 
updateBaseEndpointpublic final void updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters. - Parameters:
- endpoint- The updated endpoint to use
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 - 
getMinimumClientCommonLibraryVersionFromClientpublic Optional<String> getMinimumClientCommonLibraryVersionFromClient() 
 - 
clientCallprotected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder) 
 
- 
 
-