com.oracle.bmc.optimizer

Class OptimizerAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.optimizer.OptimizerAsyncClient

All Implemented Interfaces:

OptimizerAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200606")
public class OptimizerAsyncClient
extends BaseAsyncClient
implements OptimizerAsync

Async client implementation for Optimizer service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, 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 Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptimizerAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Optimizer.

Constructor Summary

Constructors

Constructor and Description
OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OptimizerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
OptimizerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
OptimizerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static OptimizerAsyncClient.Builder	builder() Create a builder for this client.
Future<BulkApplyRecommendationsResponse>	bulkApplyRecommendations(BulkApplyRecommendationsRequest request, AsyncHandler<BulkApplyRecommendationsRequest,BulkApplyRecommendationsResponse> handler) Applies the specified recommendations to the resources.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateProfileResponse>	createProfile(CreateProfileRequest request, AsyncHandler<CreateProfileRequest,CreateProfileResponse> handler) Creates a new profile.
Future<DeleteProfileResponse>	deleteProfile(DeleteProfileRequest request, AsyncHandler<DeleteProfileRequest,DeleteProfileResponse> handler) Deletes the specified profile.
Future<FilterResourceActionsResponse>	filterResourceActions(FilterResourceActionsRequest request, AsyncHandler<FilterResourceActionsRequest,FilterResourceActionsResponse> handler) Queries the Cloud Advisor resource actions that are supported.
Future<GetCategoryResponse>	getCategory(GetCategoryRequest request, AsyncHandler<GetCategoryRequest,GetCategoryResponse> handler) Gets the category that corresponds to the specified OCID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetEnrollmentStatusResponse>	getEnrollmentStatus(GetEnrollmentStatusRequest request, AsyncHandler<GetEnrollmentStatusRequest,GetEnrollmentStatusResponse> handler) Gets the Cloud Advisor enrollment status.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetProfileResponse>	getProfile(GetProfileRequest request, AsyncHandler<GetProfileRequest,GetProfileResponse> handler) Gets the specified profile’s information.
Future<GetRecommendationResponse>	getRecommendation(GetRecommendationRequest request, AsyncHandler<GetRecommendationRequest,GetRecommendationResponse> handler) Gets the recommendation for the specified OCID.
Future<GetResourceActionResponse>	getResourceAction(GetResourceActionRequest request, AsyncHandler<GetResourceActionRequest,GetResourceActionResponse> handler) Gets the resource action that corresponds to the specified OCID.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request associated with the specified ID.
Future<ListCategoriesResponse>	listCategories(ListCategoriesRequest request, AsyncHandler<ListCategoriesRequest,ListCategoriesResponse> handler) Lists the supported Cloud Advisor categories.
Future<ListEnrollmentStatusesResponse>	listEnrollmentStatuses(ListEnrollmentStatusesRequest request, AsyncHandler<ListEnrollmentStatusesRequest,ListEnrollmentStatusesResponse> handler) Lists the Cloud Advisor enrollment statuses.
Future<ListHistoriesResponse>	listHistories(ListHistoriesRequest request, AsyncHandler<ListHistoriesRequest,ListHistoriesResponse> handler) Lists changes to the recommendations based on user activity.
Future<ListProfileLevelsResponse>	listProfileLevels(ListProfileLevelsRequest request, AsyncHandler<ListProfileLevelsRequest,ListProfileLevelsResponse> handler) Lists the existing profile levels.
Future<ListProfilesResponse>	listProfiles(ListProfilesRequest request, AsyncHandler<ListProfilesRequest,ListProfilesResponse> handler) Lists the existing profiles.
Future<ListRecommendationsResponse>	listRecommendations(ListRecommendationsRequest request, AsyncHandler<ListRecommendationsRequest,ListRecommendationsResponse> handler) Lists the Cloud Advisor recommendations that are currently supported.
Future<ListRecommendationStrategiesResponse>	listRecommendationStrategies(ListRecommendationStrategiesRequest request, AsyncHandler<ListRecommendationStrategiesRequest,ListRecommendationStrategiesResponse> handler) Lists the existing strategies.
Future<ListResourceActionQueryableFieldsResponse>	listResourceActionQueryableFields(ListResourceActionQueryableFieldsRequest request, AsyncHandler<ListResourceActionQueryableFieldsRequest,ListResourceActionQueryableFieldsResponse> handler) Lists the fields that are indexed for querying and their associated value types.
Future<ListResourceActionsResponse>	listResourceActions(ListResourceActionsRequest request, AsyncHandler<ListResourceActionsRequest,ListResourceActionsResponse> handler) Lists the Cloud Advisor resource actions that are supported.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Lists errors associated with the specified work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Lists the logs associated with the specified work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in the tenancy.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateEnrollmentStatusResponse>	updateEnrollmentStatus(UpdateEnrollmentStatusRequest request, AsyncHandler<UpdateEnrollmentStatusRequest,UpdateEnrollmentStatusResponse> handler) Updates the enrollment status of the tenancy.
Future<UpdateProfileResponse>	updateProfile(UpdateProfileRequest request, AsyncHandler<UpdateProfileRequest,UpdateProfileResponse> handler) Updates the specified profile.
Future<UpdateRecommendationResponse>	updateRecommendation(UpdateRecommendationRequest request, AsyncHandler<UpdateRecommendationRequest,UpdateRecommendationResponse> handler) Updates the recommendation that corresponds to the specified OCID.
Future<UpdateResourceActionResponse>	updateResourceAction(UpdateResourceActionRequest request, AsyncHandler<UpdateResourceActionRequest,UpdateResourceActionResponse> handler) Updates the resource action that corresponds to the specified OCID.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.optimizer.OptimizerAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Optimizer.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

OptimizerAsyncClient

@Deprecated
public OptimizerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OptimizerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

OptimizerAsyncClient

@Deprecated
public OptimizerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OptimizerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

OptimizerAsyncClient

@Deprecated
public OptimizerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration,
                                        ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OptimizerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

OptimizerAsyncClient

@Deprecated
public OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration,
                                        ClientConfigurator clientConfigurator,
                                        RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OptimizerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OptimizerAsyncClient

@Deprecated
public OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration,
                                        ClientConfigurator clientConfigurator,
                                        RequestSignerFactory defaultRequestSignerFactory,
                                        List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OptimizerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OptimizerAsyncClient

@Deprecated
public OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration,
                                        ClientConfigurator clientConfigurator,
                                        RequestSignerFactory defaultRequestSignerFactory,
                                        List<ClientConfigurator> additionalClientConfigurators,
                                        String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OptimizerAsyncClient.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)

OptimizerAsyncClient

@Deprecated
public OptimizerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration,
                                        ClientConfigurator clientConfigurator,
                                        RequestSignerFactory defaultRequestSignerFactory,
                                        Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                        List<ClientConfigurator> additionalClientConfigurators,
                                        String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OptimizerAsyncClient.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

builder

public static OptimizerAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OptimizerAsync

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface OptimizerAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OptimizerAsync

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface OptimizerAsync

Parameters:

regionId - The public region ID.

bulkApplyRecommendations

public Future<BulkApplyRecommendationsResponse> bulkApplyRecommendations(BulkApplyRecommendationsRequest request,
                                                                         AsyncHandler<BulkApplyRecommendationsRequest,BulkApplyRecommendationsResponse> handler)

Description copied from interface: OptimizerAsync

Applies the specified recommendations to the resources.

Specified by:

bulkApplyRecommendations in interface OptimizerAsync

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.

createProfile

public Future<CreateProfileResponse> createProfile(CreateProfileRequest request,
                                                   AsyncHandler<CreateProfileRequest,CreateProfileResponse> handler)

Description copied from interface: OptimizerAsync

Creates a new profile.

Specified by:

createProfile in interface OptimizerAsync

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.

deleteProfile

public Future<DeleteProfileResponse> deleteProfile(DeleteProfileRequest request,
                                                   AsyncHandler<DeleteProfileRequest,DeleteProfileResponse> handler)

Description copied from interface: OptimizerAsync

Deletes the specified profile. Uses the profile’s OCID to determine which profile to delete.

Specified by:

deleteProfile in interface OptimizerAsync

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.

filterResourceActions

public Future<FilterResourceActionsResponse> filterResourceActions(FilterResourceActionsRequest request,
                                                                   AsyncHandler<FilterResourceActionsRequest,FilterResourceActionsResponse> handler)

Description copied from interface: OptimizerAsync

Queries the Cloud Advisor resource actions that are supported.

Specified by:

filterResourceActions in interface OptimizerAsync

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.

getCategory

public Future<GetCategoryResponse> getCategory(GetCategoryRequest request,
                                               AsyncHandler<GetCategoryRequest,GetCategoryResponse> handler)

Description copied from interface: OptimizerAsync

Gets the category that corresponds to the specified OCID.

Specified by:

getCategory in interface OptimizerAsync

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.

getEnrollmentStatus

public Future<GetEnrollmentStatusResponse> getEnrollmentStatus(GetEnrollmentStatusRequest request,
                                                               AsyncHandler<GetEnrollmentStatusRequest,GetEnrollmentStatusResponse> handler)

Description copied from interface: OptimizerAsync

Gets the Cloud Advisor enrollment status.

Specified by:

getEnrollmentStatus in interface OptimizerAsync

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.

getProfile

public Future<GetProfileResponse> getProfile(GetProfileRequest request,
                                             AsyncHandler<GetProfileRequest,GetProfileResponse> handler)

Description copied from interface: OptimizerAsync

Gets the specified profile’s information. Uses the profile’s OCID to determine which profile to retrieve.

Specified by:

getProfile in interface OptimizerAsync

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.

getRecommendation

public Future<GetRecommendationResponse> getRecommendation(GetRecommendationRequest request,
                                                           AsyncHandler<GetRecommendationRequest,GetRecommendationResponse> handler)

Description copied from interface: OptimizerAsync

Gets the recommendation for the specified OCID.

Specified by:

getRecommendation in interface OptimizerAsync

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.

getResourceAction

public Future<GetResourceActionResponse> getResourceAction(GetResourceActionRequest request,
                                                           AsyncHandler<GetResourceActionRequest,GetResourceActionResponse> handler)

Description copied from interface: OptimizerAsync

Gets the resource action that corresponds to the specified OCID.

Specified by:

getResourceAction in interface OptimizerAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: OptimizerAsync

Gets the status of the work request associated with the specified ID.

Specified by:

getWorkRequest in interface OptimizerAsync

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.

listCategories

public Future<ListCategoriesResponse> listCategories(ListCategoriesRequest request,
                                                     AsyncHandler<ListCategoriesRequest,ListCategoriesResponse> handler)

Description copied from interface: OptimizerAsync

Lists the supported Cloud Advisor categories.

Specified by:

listCategories in interface OptimizerAsync

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.

listEnrollmentStatuses

public Future<ListEnrollmentStatusesResponse> listEnrollmentStatuses(ListEnrollmentStatusesRequest request,
                                                                     AsyncHandler<ListEnrollmentStatusesRequest,ListEnrollmentStatusesResponse> handler)

Description copied from interface: OptimizerAsync

Lists the Cloud Advisor enrollment statuses.

Specified by:

listEnrollmentStatuses in interface OptimizerAsync

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.

listHistories

public Future<ListHistoriesResponse> listHistories(ListHistoriesRequest request,
                                                   AsyncHandler<ListHistoriesRequest,ListHistoriesResponse> handler)

Description copied from interface: OptimizerAsync

Lists changes to the recommendations based on user activity. For example, lists when recommendations have been implemented, dismissed, postponed, or reactivated.

Specified by:

listHistories in interface OptimizerAsync

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.

listProfileLevels

public Future<ListProfileLevelsResponse> listProfileLevels(ListProfileLevelsRequest request,
                                                           AsyncHandler<ListProfileLevelsRequest,ListProfileLevelsResponse> handler)

Description copied from interface: OptimizerAsync

Lists the existing profile levels.

Specified by:

listProfileLevels in interface OptimizerAsync

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.

listProfiles

public Future<ListProfilesResponse> listProfiles(ListProfilesRequest request,
                                                 AsyncHandler<ListProfilesRequest,ListProfilesResponse> handler)

Description copied from interface: OptimizerAsync

Lists the existing profiles.

Specified by:

listProfiles in interface OptimizerAsync

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.

listRecommendationStrategies

public Future<ListRecommendationStrategiesResponse> listRecommendationStrategies(ListRecommendationStrategiesRequest request,
                                                                                 AsyncHandler<ListRecommendationStrategiesRequest,ListRecommendationStrategiesResponse> handler)

Description copied from interface: OptimizerAsync

Lists the existing strategies.

Specified by:

listRecommendationStrategies in interface OptimizerAsync

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.

listRecommendations

public Future<ListRecommendationsResponse> listRecommendations(ListRecommendationsRequest request,
                                                               AsyncHandler<ListRecommendationsRequest,ListRecommendationsResponse> handler)

Description copied from interface: OptimizerAsync

Lists the Cloud Advisor recommendations that are currently supported.

Specified by:

listRecommendations in interface OptimizerAsync

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.

listResourceActionQueryableFields

public Future<ListResourceActionQueryableFieldsResponse> listResourceActionQueryableFields(ListResourceActionQueryableFieldsRequest request,
                                                                                           AsyncHandler<ListResourceActionQueryableFieldsRequest,ListResourceActionQueryableFieldsResponse> handler)

Description copied from interface: OptimizerAsync

Lists the fields that are indexed for querying and their associated value types.

Specified by:

listResourceActionQueryableFields in interface OptimizerAsync

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.

listResourceActions

public Future<ListResourceActionsResponse> listResourceActions(ListResourceActionsRequest request,
                                                               AsyncHandler<ListResourceActionsRequest,ListResourceActionsResponse> handler)

Description copied from interface: OptimizerAsync

Lists the Cloud Advisor resource actions that are supported.

Specified by:

listResourceActions in interface OptimizerAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: OptimizerAsync

Lists errors associated with the specified work request.

Specified by:

listWorkRequestErrors in interface OptimizerAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: OptimizerAsync

Lists the logs associated with the specified work request.

Specified by:

listWorkRequestLogs in interface OptimizerAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: OptimizerAsync

Lists the work requests in the tenancy. The tenancy is the root compartment.

Specified by:

listWorkRequests in interface OptimizerAsync

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.

updateEnrollmentStatus

public Future<UpdateEnrollmentStatusResponse> updateEnrollmentStatus(UpdateEnrollmentStatusRequest request,
                                                                     AsyncHandler<UpdateEnrollmentStatusRequest,UpdateEnrollmentStatusResponse> handler)

Description copied from interface: OptimizerAsync

Updates the enrollment status of the tenancy.

Specified by:

updateEnrollmentStatus in interface OptimizerAsync

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.

updateProfile

public Future<UpdateProfileResponse> updateProfile(UpdateProfileRequest request,
                                                   AsyncHandler<UpdateProfileRequest,UpdateProfileResponse> handler)

Description copied from interface: OptimizerAsync

Updates the specified profile. Uses the profile’s OCID to determine which profile to update.

Specified by:

updateProfile in interface OptimizerAsync

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.

updateRecommendation

public Future<UpdateRecommendationResponse> updateRecommendation(UpdateRecommendationRequest request,
                                                                 AsyncHandler<UpdateRecommendationRequest,UpdateRecommendationResponse> handler)

Description copied from interface: OptimizerAsync

Updates the recommendation that corresponds to the specified OCID. Use this operation to implement the following actions:

Postpone recommendation * Dismiss recommendation * Reactivate recommendation

Specified by:

updateRecommendation in interface OptimizerAsync

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.

updateResourceAction

public Future<UpdateResourceActionResponse> updateResourceAction(UpdateResourceActionRequest request,
                                                                 AsyncHandler<UpdateResourceActionRequest,UpdateResourceActionResponse> handler)

Description copied from interface: OptimizerAsync

Updates the resource action that corresponds to the specified OCID. Use this operation to implement the following actions:

Postpone resource action * Ignore resource action * Reactivate resource action

Specified by:

updateResourceAction in interface OptimizerAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public 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

populateServiceParametersInEndpoint

public 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

updateBaseEndpoint

public 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

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)