Class JmsUtilsClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.jmsutils.JmsUtilsClient
-
- All Implemented Interfaces:
JmsUtils,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20250521") public class JmsUtilsClient extends BaseSyncClient implements JmsUtils
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classJmsUtilsClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for JmsUtils.
-
Constructor Summary
Constructors Constructor Description JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JmsUtilsClient.Builderbuilder()Create a builder for this client.CancelWorkRequestResponsecancelWorkRequest(CancelWorkRequestRequest request)Cancels a work request.voidclose()DeleteJavaMigrationAnalysisResponsedeleteJavaMigrationAnalysis(DeleteJavaMigrationAnalysisRequest request)Deletes a Java Migration Analysis.DeletePerformanceTuningAnalysisResponsedeletePerformanceTuningAnalysis(DeletePerformanceTuningAnalysisRequest request)Deletes a Performance Tuning Analysis.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetAnalyzeApplicationsConfigurationResponsegetAnalyzeApplicationsConfiguration(GetAnalyzeApplicationsConfigurationRequest request)Returns the configuration for analyzing applications.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetJavaMigrationAnalysisResponsegetJavaMigrationAnalysis(GetJavaMigrationAnalysisRequest request)Gets information about a Java Migration Analysis.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.JmsUtilsPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPerformanceTuningAnalysisResponsegetPerformanceTuningAnalysis(GetPerformanceTuningAnalysisRequest request)Gets information about a Performance Tuning Analysis.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.GetSubscriptionAcknowledgmentConfigurationResponsegetSubscriptionAcknowledgmentConfiguration(GetSubscriptionAcknowledgmentConfigurationRequest request)Returns the configuration for subscription acknowledgment.JmsUtilsWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the details of a work request.ListJavaMigrationAnalysisResponselistJavaMigrationAnalysis(ListJavaMigrationAnalysisRequest request)Gets a list of Java Migration Analysis.ListPerformanceTuningAnalysisResponselistPerformanceTuningAnalysis(ListPerformanceTuningAnalysisRequest request)Gets a list of Performance tuning Analysis.ListWorkItemsResponselistWorkItems(ListWorkItemsRequest request)Retrieve a paginated list of work items for a specified work request.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Lists the errors for a work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Lists the logs for a work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.voidrefreshClient()Rebuild the backingHttpClient.RequestJavaMigrationAnalysisResponserequestJavaMigrationAnalysis(RequestJavaMigrationAnalysisRequest request)Requests Java Migration Analysis.RequestPerformanceTuningAnalysisResponserequestPerformanceTuningAnalysis(RequestPerformanceTuningAnalysisRequest request)Requests Performance Tuning Analysis.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateAnalyzeApplicationsConfigurationResponseupdateAnalyzeApplicationsConfiguration(UpdateAnalyzeApplicationsConfigurationRequest request)Updates the configuration for analyze application.UpdateSubscriptionAcknowledgmentConfigurationResponseupdateSubscriptionAcknowledgmentConfiguration(UpdateSubscriptionAcknowledgmentConfigurationRequest request)Updates the configuration for subscription acknowledgment.voiduseRealmSpecificEndpointTemplate(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.jmsutils.JmsUtils
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
JmsUtilsClient
@Deprecated public JmsUtilsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeJmsUtilsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-JmsUtilsClient.Builder.executorService
-
-
Method Detail
-
builder
public static JmsUtilsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:JmsUtilsSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:JmsUtilsSets 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.
-
cancelWorkRequest
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Description copied from interface:JmsUtilsCancels a work request.- Specified by:
cancelWorkRequestin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteJavaMigrationAnalysis
public DeleteJavaMigrationAnalysisResponse deleteJavaMigrationAnalysis(DeleteJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtilsDeletes a Java Migration Analysis.- Specified by:
deleteJavaMigrationAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePerformanceTuningAnalysis
public DeletePerformanceTuningAnalysisResponse deletePerformanceTuningAnalysis(DeletePerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtilsDeletes a Performance Tuning Analysis.- Specified by:
deletePerformanceTuningAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAnalyzeApplicationsConfiguration
public GetAnalyzeApplicationsConfigurationResponse getAnalyzeApplicationsConfiguration(GetAnalyzeApplicationsConfigurationRequest request)
Description copied from interface:JmsUtilsReturns the configuration for analyzing applications.- Specified by:
getAnalyzeApplicationsConfigurationin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJavaMigrationAnalysis
public GetJavaMigrationAnalysisResponse getJavaMigrationAnalysis(GetJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtilsGets information about a Java Migration Analysis.- Specified by:
getJavaMigrationAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPerformanceTuningAnalysis
public GetPerformanceTuningAnalysisResponse getPerformanceTuningAnalysis(GetPerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtilsGets information about a Performance Tuning Analysis.- Specified by:
getPerformanceTuningAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSubscriptionAcknowledgmentConfiguration
public GetSubscriptionAcknowledgmentConfigurationResponse getSubscriptionAcknowledgmentConfiguration(GetSubscriptionAcknowledgmentConfigurationRequest request)
Description copied from interface:JmsUtilsReturns the configuration for subscription acknowledgment.- Specified by:
getSubscriptionAcknowledgmentConfigurationin interfaceJmsUtils- 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:JmsUtilsGets the details of a work request.- Specified by:
getWorkRequestin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJavaMigrationAnalysis
public ListJavaMigrationAnalysisResponse listJavaMigrationAnalysis(ListJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtilsGets a list of Java Migration Analysis.- Specified by:
listJavaMigrationAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPerformanceTuningAnalysis
public ListPerformanceTuningAnalysisResponse listPerformanceTuningAnalysis(ListPerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtilsGets a list of Performance tuning Analysis.- Specified by:
listPerformanceTuningAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkItems
public ListWorkItemsResponse listWorkItems(ListWorkItemsRequest request)
Description copied from interface:JmsUtilsRetrieve a paginated list of work items for a specified work request.- Specified by:
listWorkItemsin interfaceJmsUtils- 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:JmsUtilsLists the errors for a work request.- Specified by:
listWorkRequestErrorsin interfaceJmsUtils- 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:JmsUtilsLists the logs for a work request.- Specified by:
listWorkRequestLogsin interfaceJmsUtils- 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:JmsUtilsLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestJavaMigrationAnalysis
public RequestJavaMigrationAnalysisResponse requestJavaMigrationAnalysis(RequestJavaMigrationAnalysisRequest request)
Description copied from interface:JmsUtilsRequests Java Migration Analysis.- Specified by:
requestJavaMigrationAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
requestPerformanceTuningAnalysis
public RequestPerformanceTuningAnalysisResponse requestPerformanceTuningAnalysis(RequestPerformanceTuningAnalysisRequest request)
Description copied from interface:JmsUtilsRequests Performance Tuning Analysis.- Specified by:
requestPerformanceTuningAnalysisin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAnalyzeApplicationsConfiguration
public UpdateAnalyzeApplicationsConfigurationResponse updateAnalyzeApplicationsConfiguration(UpdateAnalyzeApplicationsConfigurationRequest request)
Description copied from interface:JmsUtilsUpdates the configuration for analyze application.- Specified by:
updateAnalyzeApplicationsConfigurationin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSubscriptionAcknowledgmentConfiguration
public UpdateSubscriptionAcknowledgmentConfigurationResponse updateSubscriptionAcknowledgmentConfiguration(UpdateSubscriptionAcknowledgmentConfigurationRequest request)
Description copied from interface:JmsUtilsUpdates the configuration for subscription acknowledgment.- Specified by:
updateSubscriptionAcknowledgmentConfigurationin interfaceJmsUtils- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public JmsUtilsWaiters getWaiters()
Description copied from interface:JmsUtilsGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceJmsUtils- Returns:
- The service waiters.
-
getPaginators
public JmsUtilsPaginators getPaginators()
Description copied from interface:JmsUtilsGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceJmsUtils- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-