@Generated(value="OracleSDKGenerator", comments="API Version: 20200606") public class OptimizerClient extends Object implements Optimizer
Modifier and Type | Class and Description |
---|---|
static class |
OptimizerClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Optimizer.
|
Modifier | Constructor and Description |
---|---|
|
OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static OptimizerClient.Builder |
builder()
Create a builder for this client.
|
BulkApplyRecommendationsResponse |
bulkApplyRecommendations(BulkApplyRecommendationsRequest request)
Applies the specified recommendations to the resources.
|
void |
close() |
CreateProfileResponse |
createProfile(CreateProfileRequest request)
Creates a new profile.
|
DeleteProfileResponse |
deleteProfile(DeleteProfileRequest request)
Deletes the specified profile.
|
FilterResourceActionsResponse |
filterResourceActions(FilterResourceActionsRequest request)
Queries the Cloud Advisor resource actions that are supported by the specified recommendation.
|
GetCategoryResponse |
getCategory(GetCategoryRequest request)
Gets the category that corresponds to the specified OCID.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetEnrollmentStatusResponse |
getEnrollmentStatus(GetEnrollmentStatusRequest request)
Gets the Cloud Advisor enrollment status.
|
OptimizerPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
GetProfileResponse |
getProfile(GetProfileRequest request)
Gets the specified profile’s information.
|
GetRecommendationResponse |
getRecommendation(GetRecommendationRequest request)
Gets the recommendation for the specified OCID.
|
GetResourceActionResponse |
getResourceAction(GetResourceActionRequest request)
Gets the resource action that corresponds to the specified OCID.
|
OptimizerWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request associated with the specified ID.
|
ListCategoriesResponse |
listCategories(ListCategoriesRequest request)
Lists the supported Cloud Advisor categories.
|
ListEnrollmentStatusesResponse |
listEnrollmentStatuses(ListEnrollmentStatusesRequest request)
Lists the Cloud Advisor enrollment statuses.
|
ListHistoriesResponse |
listHistories(ListHistoriesRequest request)
Lists changes to the recommendations based on user activity.
|
ListProfileLevelsResponse |
listProfileLevels(ListProfileLevelsRequest request)
Lists the existing profile levels.
|
ListProfilesResponse |
listProfiles(ListProfilesRequest request)
Lists the existing profiles.
|
ListRecommendationsResponse |
listRecommendations(ListRecommendationsRequest request)
Lists the Cloud Advisor recommendations that are currently supported in the specified category.
|
ListRecommendationStrategiesResponse |
listRecommendationStrategies(ListRecommendationStrategiesRequest request)
Lists the existing strategies.
|
ListResourceActionQueryableFieldsResponse |
listResourceActionQueryableFields(ListResourceActionQueryableFieldsRequest request)
Lists the fields that are indexed for querying and their associated value types.
|
ListResourceActionsResponse |
listResourceActions(ListResourceActionsRequest request)
Lists the Cloud Advisor resource actions that are supported by the specified recommendation.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Lists errors associated with the specified work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Lists the logs associated with the specified work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in the tenancy.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateEnrollmentStatusResponse |
updateEnrollmentStatus(UpdateEnrollmentStatusRequest request)
Updates the enrollment status of the tenancy.
|
UpdateProfileResponse |
updateProfile(UpdateProfileRequest request)
Updates the specified profile.
|
UpdateRecommendationResponse |
updateRecommendation(UpdateRecommendationRequest request)
Updates the recommendation that corresponds to the specified OCID.
|
UpdateResourceActionResponse |
updateResourceAction(UpdateResourceActionRequest request)
Updates the resource action that corresponds to the specified OCID.
|
public static final Service SERVICE
Service instance for Optimizer.
public OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the OptimizerClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static OptimizerClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Optimizer
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Optimizer
endpoint
- The endpoint of the service.public String getEndpoint()
Optimizer
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Optimizer
public void setRegion(Region region)
Optimizer
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.
public void setRegion(String regionId)
Optimizer
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
.
public void close()
close
in interface AutoCloseable
public BulkApplyRecommendationsResponse bulkApplyRecommendations(BulkApplyRecommendationsRequest request)
Optimizer
Applies the specified recommendations to the resources.
bulkApplyRecommendations
in interface Optimizer
request
- The request object containing the details to sendpublic CreateProfileResponse createProfile(CreateProfileRequest request)
Optimizer
Creates a new profile.
createProfile
in interface Optimizer
request
- The request object containing the details to sendpublic DeleteProfileResponse deleteProfile(DeleteProfileRequest request)
Optimizer
Deletes the specified profile. Uses the profile’s OCID to determine which profile to delete.
deleteProfile
in interface Optimizer
request
- The request object containing the details to sendpublic FilterResourceActionsResponse filterResourceActions(FilterResourceActionsRequest request)
Optimizer
Queries the Cloud Advisor resource actions that are supported by the specified recommendation.
filterResourceActions
in interface Optimizer
request
- The request object containing the details to sendpublic GetCategoryResponse getCategory(GetCategoryRequest request)
Optimizer
Gets the category that corresponds to the specified OCID.
getCategory
in interface Optimizer
request
- The request object containing the details to sendpublic GetEnrollmentStatusResponse getEnrollmentStatus(GetEnrollmentStatusRequest request)
Optimizer
Gets the Cloud Advisor enrollment status.
getEnrollmentStatus
in interface Optimizer
request
- The request object containing the details to sendpublic GetProfileResponse getProfile(GetProfileRequest request)
Optimizer
Gets the specified profile’s information. Uses the profile’s OCID to determine which profile to retrieve.
getProfile
in interface Optimizer
request
- The request object containing the details to sendpublic GetRecommendationResponse getRecommendation(GetRecommendationRequest request)
Optimizer
Gets the recommendation for the specified OCID.
getRecommendation
in interface Optimizer
request
- The request object containing the details to sendpublic GetResourceActionResponse getResourceAction(GetResourceActionRequest request)
Optimizer
Gets the resource action that corresponds to the specified OCID.
getResourceAction
in interface Optimizer
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Optimizer
Gets the status of the work request associated with the specified ID.
getWorkRequest
in interface Optimizer
request
- The request object containing the details to sendpublic ListCategoriesResponse listCategories(ListCategoriesRequest request)
Optimizer
Lists the supported Cloud Advisor categories.
listCategories
in interface Optimizer
request
- The request object containing the details to sendpublic ListEnrollmentStatusesResponse listEnrollmentStatuses(ListEnrollmentStatusesRequest request)
Optimizer
Lists the Cloud Advisor enrollment statuses.
listEnrollmentStatuses
in interface Optimizer
request
- The request object containing the details to sendpublic ListHistoriesResponse listHistories(ListHistoriesRequest request)
Optimizer
Lists changes to the recommendations based on user activity. For example, lists when recommendations have been implemented, dismissed, postponed, or reactivated.
listHistories
in interface Optimizer
request
- The request object containing the details to sendpublic ListProfileLevelsResponse listProfileLevels(ListProfileLevelsRequest request)
Optimizer
Lists the existing profile levels.
listProfileLevels
in interface Optimizer
request
- The request object containing the details to sendpublic ListProfilesResponse listProfiles(ListProfilesRequest request)
Optimizer
Lists the existing profiles.
listProfiles
in interface Optimizer
request
- The request object containing the details to sendpublic ListRecommendationStrategiesResponse listRecommendationStrategies(ListRecommendationStrategiesRequest request)
Optimizer
Lists the existing strategies.
listRecommendationStrategies
in interface Optimizer
request
- The request object containing the details to sendpublic ListRecommendationsResponse listRecommendations(ListRecommendationsRequest request)
Optimizer
Lists the Cloud Advisor recommendations that are currently supported in the specified category.
listRecommendations
in interface Optimizer
request
- The request object containing the details to sendpublic ListResourceActionQueryableFieldsResponse listResourceActionQueryableFields(ListResourceActionQueryableFieldsRequest request)
Optimizer
Lists the fields that are indexed for querying and their associated value types.
listResourceActionQueryableFields
in interface Optimizer
request
- The request object containing the details to sendpublic ListResourceActionsResponse listResourceActions(ListResourceActionsRequest request)
Optimizer
Lists the Cloud Advisor resource actions that are supported by the specified recommendation.
listResourceActions
in interface Optimizer
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Optimizer
Lists errors associated with the specified work request.
listWorkRequestErrors
in interface Optimizer
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Optimizer
Lists the logs associated with the specified work request.
listWorkRequestLogs
in interface Optimizer
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Optimizer
Lists the work requests in the tenancy. The tenancy is the root compartment.
listWorkRequests
in interface Optimizer
request
- The request object containing the details to sendpublic UpdateEnrollmentStatusResponse updateEnrollmentStatus(UpdateEnrollmentStatusRequest request)
Optimizer
Updates the enrollment status of the tenancy.
updateEnrollmentStatus
in interface Optimizer
request
- The request object containing the details to sendpublic UpdateProfileResponse updateProfile(UpdateProfileRequest request)
Optimizer
Updates the specified profile. Uses the profile’s OCID to determine which profile to update.
updateProfile
in interface Optimizer
request
- The request object containing the details to sendpublic UpdateRecommendationResponse updateRecommendation(UpdateRecommendationRequest request)
Optimizer
Updates the recommendation that corresponds to the specified OCID. Use this operation to implement the following actions:
Postpone recommendation * Dismiss recommendation * Reactivate recommendation
updateRecommendation
in interface Optimizer
request
- The request object containing the details to sendpublic UpdateResourceActionResponse updateResourceAction(UpdateResourceActionRequest request)
Optimizer
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
updateResourceAction
in interface Optimizer
request
- The request object containing the details to sendpublic OptimizerWaiters getWaiters()
Optimizer
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Optimizer
public OptimizerPaginators getPaginators()
Optimizer
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable
interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
getPaginators
in interface Optimizer
Copyright © 2016–2022. All rights reserved.