Class OptimizerClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.optimizer.OptimizerClient
-
- All Implemented Interfaces:
Optimizer
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200606") public class OptimizerClient extends BaseSyncClient implements Optimizer
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OptimizerClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 Description OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.GetCategoryResponse
getCategory(GetCategoryRequest request)
Gets the category that corresponds to the specified OCID.String
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
GetEnrollmentStatusResponse
getEnrollmentStatus(GetEnrollmentStatusRequest request)
Gets the Cloud Advisor enrollment status.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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.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.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
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 backingHttpClient
.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.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.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.optimizer.Optimizer
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
OptimizerClient
@Deprecated public OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
OptimizerClient
@Deprecated public OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
OptimizerClient
@Deprecated public OptimizerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
OptimizerClient
@Deprecated public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
OptimizerClient
@Deprecated public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
OptimizerClient
@Deprecated public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.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)
-
OptimizerClient
@Deprecated public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.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
-
OptimizerClient
@Deprecated public OptimizerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeOptimizerClient.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
executorService
-OptimizerClient.Builder.executorService
-
-
Method Detail
-
builder
public static OptimizerClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface: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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface: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 callsetEndpoint
.
-
bulkApplyRecommendations
public BulkApplyRecommendationsResponse bulkApplyRecommendations(BulkApplyRecommendationsRequest request)
Description copied from interface:Optimizer
Applies the specified recommendations to the resources.- Specified by:
bulkApplyRecommendations
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createProfile
public CreateProfileResponse createProfile(CreateProfileRequest request)
Description copied from interface:Optimizer
Creates a new profile.- Specified by:
createProfile
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteProfile
public DeleteProfileResponse deleteProfile(DeleteProfileRequest request)
Description copied from interface:Optimizer
Deletes the specified profile.Uses the profile’s OCID to determine which profile to delete.
- Specified by:
deleteProfile
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
filterResourceActions
public FilterResourceActionsResponse filterResourceActions(FilterResourceActionsRequest request)
Description copied from interface:Optimizer
Queries the Cloud Advisor resource actions that are supported.- Specified by:
filterResourceActions
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCategory
public GetCategoryResponse getCategory(GetCategoryRequest request)
Description copied from interface:Optimizer
Gets the category that corresponds to the specified OCID.- Specified by:
getCategory
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getEnrollmentStatus
public GetEnrollmentStatusResponse getEnrollmentStatus(GetEnrollmentStatusRequest request)
Description copied from interface:Optimizer
Gets the Cloud Advisor enrollment status.- Specified by:
getEnrollmentStatus
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getProfile
public GetProfileResponse getProfile(GetProfileRequest request)
Description copied from interface:Optimizer
Gets the specified profile’s information.Uses the profile’s OCID to determine which profile to retrieve.
- Specified by:
getProfile
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRecommendation
public GetRecommendationResponse getRecommendation(GetRecommendationRequest request)
Description copied from interface:Optimizer
Gets the recommendation for the specified OCID.- Specified by:
getRecommendation
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getResourceAction
public GetResourceActionResponse getResourceAction(GetResourceActionRequest request)
Description copied from interface:Optimizer
Gets the resource action that corresponds to the specified OCID.- Specified by:
getResourceAction
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:Optimizer
Gets the status of the work request associated with the specified ID.- Specified by:
getWorkRequest
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCategories
public ListCategoriesResponse listCategories(ListCategoriesRequest request)
Description copied from interface:Optimizer
Lists the supported Cloud Advisor categories.- Specified by:
listCategories
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEnrollmentStatuses
public ListEnrollmentStatusesResponse listEnrollmentStatuses(ListEnrollmentStatusesRequest request)
Description copied from interface:Optimizer
Lists the Cloud Advisor enrollment statuses.- Specified by:
listEnrollmentStatuses
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHistories
public ListHistoriesResponse listHistories(ListHistoriesRequest request)
Description copied from interface:Optimizer
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 interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProfileLevels
public ListProfileLevelsResponse listProfileLevels(ListProfileLevelsRequest request)
Description copied from interface:Optimizer
Lists the existing profile levels.- Specified by:
listProfileLevels
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProfiles
public ListProfilesResponse listProfiles(ListProfilesRequest request)
Description copied from interface:Optimizer
Lists the existing profiles.- Specified by:
listProfiles
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRecommendationStrategies
public ListRecommendationStrategiesResponse listRecommendationStrategies(ListRecommendationStrategiesRequest request)
Description copied from interface:Optimizer
Lists the existing strategies.- Specified by:
listRecommendationStrategies
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRecommendations
public ListRecommendationsResponse listRecommendations(ListRecommendationsRequest request)
Description copied from interface:Optimizer
Lists the Cloud Advisor recommendations that are currently supported.- Specified by:
listRecommendations
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceActionQueryableFields
public ListResourceActionQueryableFieldsResponse listResourceActionQueryableFields(ListResourceActionQueryableFieldsRequest request)
Description copied from interface:Optimizer
Lists the fields that are indexed for querying and their associated value types.- Specified by:
listResourceActionQueryableFields
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listResourceActions
public ListResourceActionsResponse listResourceActions(ListResourceActionsRequest request)
Description copied from interface:Optimizer
Lists the Cloud Advisor resource actions that are supported.- Specified by:
listResourceActions
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:Optimizer
Lists errors associated with the specified work request.- Specified by:
listWorkRequestErrors
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:Optimizer
Lists the logs associated with the specified work request.- Specified by:
listWorkRequestLogs
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:Optimizer
Lists the work requests in the tenancy.The tenancy is the root compartment.
- Specified by:
listWorkRequests
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateEnrollmentStatus
public UpdateEnrollmentStatusResponse updateEnrollmentStatus(UpdateEnrollmentStatusRequest request)
Description copied from interface:Optimizer
Updates the enrollment status of the tenancy.- Specified by:
updateEnrollmentStatus
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateProfile
public UpdateProfileResponse updateProfile(UpdateProfileRequest request)
Description copied from interface:Optimizer
Updates the specified profile.Uses the profile’s OCID to determine which profile to update.
- Specified by:
updateProfile
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRecommendation
public UpdateRecommendationResponse updateRecommendation(UpdateRecommendationRequest request)
Description copied from interface:Optimizer
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 interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateResourceAction
public UpdateResourceActionResponse updateResourceAction(UpdateResourceActionRequest request)
Description copied from interface: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
- Specified by:
updateResourceAction
in interfaceOptimizer
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public OptimizerWaiters getWaiters()
Description copied from interface:Optimizer
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceOptimizer
- Returns:
- The service waiters.
-
getPaginators
public OptimizerPaginators getPaginators()
Description copied from interface: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.- Specified by:
getPaginators
in interfaceOptimizer
- Returns:
- The service paginators.
-
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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-