Class IntegrationInstanceClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.integration.IntegrationInstanceClient
-
- All Implemented Interfaces:
IntegrationInstance,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20190131") public class IntegrationInstanceClient extends BaseSyncClient implements IntegrationInstance
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classIntegrationInstanceClient.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 IntegrationInstance.
-
Constructor Summary
Constructors Constructor Description IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddOracleManagedCustomEndpointResponseaddOracleManagedCustomEndpoint(AddOracleManagedCustomEndpointRequest request)Enable Oracle Managed Custom Endpoint for given integration instance.static IntegrationInstanceClient.Builderbuilder()Create a builder for this client.ChangeIntegrationInstanceCompartmentResponsechangeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest request)Change the compartment for an integration instanceChangeIntegrationInstanceNetworkEndpointResponsechangeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest request)Change an Integration instance network endpoint.ChangePrivateEndpointOutboundConnectionResponsechangePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest request)Change private endpoint outbound connection for given Integration instance.voidclose()CreateIntegrationInstanceResponsecreateIntegrationInstance(CreateIntegrationInstanceRequest request)Creates a new Integration Instance.DeleteIntegrationInstanceResponsedeleteIntegrationInstance(DeleteIntegrationInstanceRequest request)Deletes an Integration Instance resource by identifier.DisasterRecoveryFailoverResponsedisasterRecoveryFailover(DisasterRecoveryFailoverRequest request)Allows failover for disaster recovery.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.EnableProcessAutomationResponseenableProcessAutomation(EnableProcessAutomationRequest request)Enable Process Automation for given Integration InstanceExtendDataRetentionResponseextendDataRetention(ExtendDataRetentionRequest request)Extend Data Retention period for given Integration InstanceStringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetIntegrationInstanceResponsegetIntegrationInstance(GetIntegrationInstanceRequest request)Gets a IntegrationInstance by identifierOptional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.IntegrationInstancePaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.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.IntegrationInstanceWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the status of the work request with the given ID.ListIntegrationInstancesResponselistIntegrationInstances(ListIntegrationInstancesRequest request)Returns a list of Integration Instances.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Get the errors of a work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Get the logs of a work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.voidrefreshClient()Rebuild the backingHttpClient.RemoveOracleManagedCustomEndpointResponseremoveOracleManagedCustomEndpoint(RemoveOracleManagedCustomEndpointRequest request)Remove Oracle Managed Custom Endpoint for given integration instance that was previously enabled.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’).StartIntegrationInstanceResponsestartIntegrationInstance(StartIntegrationInstanceRequest request)Start an integration instance that was previously in an INACTIVE stateStopIntegrationInstanceResponsestopIntegrationInstance(StopIntegrationInstanceRequest request)Stop an integration instance that was previously in an ACTIVE stateUpdateIntegrationInstanceResponseupdateIntegrationInstance(UpdateIntegrationInstanceRequest request)Updates the Integration Instance.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.integration.IntegrationInstance
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeIntegrationInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeIntegrationInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeIntegrationInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeIntegrationInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeIntegrationInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(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 (seeIntegrationInstanceClient.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)
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(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 (seeIntegrationInstanceClient.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
-
IntegrationInstanceClient
@Deprecated public IntegrationInstanceClient(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 (seeIntegrationInstanceClient.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-IntegrationInstanceClient.Builder.executorService
-
-
Method Detail
-
builder
public static IntegrationInstanceClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:IntegrationInstanceSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceIntegrationInstance- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:IntegrationInstanceSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
setRegionin interfaceIntegrationInstance- Parameters:
regionId- The public region ID.
-
addOracleManagedCustomEndpoint
public AddOracleManagedCustomEndpointResponse addOracleManagedCustomEndpoint(AddOracleManagedCustomEndpointRequest request)
Description copied from interface:IntegrationInstanceEnable Oracle Managed Custom Endpoint for given integration instance.- Specified by:
addOracleManagedCustomEndpointin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeIntegrationInstanceCompartment
public ChangeIntegrationInstanceCompartmentResponse changeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest request)
Description copied from interface:IntegrationInstanceChange the compartment for an integration instance- Specified by:
changeIntegrationInstanceCompartmentin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeIntegrationInstanceNetworkEndpoint
public ChangeIntegrationInstanceNetworkEndpointResponse changeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest request)
Description copied from interface:IntegrationInstanceChange an Integration instance network endpoint.The operation is long-running and creates a new WorkRequest.
- Specified by:
changeIntegrationInstanceNetworkEndpointin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changePrivateEndpointOutboundConnection
public ChangePrivateEndpointOutboundConnectionResponse changePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest request)
Description copied from interface:IntegrationInstanceChange private endpoint outbound connection for given Integration instance.The operation is long-running and creates a new WorkRequest.
- Specified by:
changePrivateEndpointOutboundConnectionin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createIntegrationInstance
public CreateIntegrationInstanceResponse createIntegrationInstance(CreateIntegrationInstanceRequest request)
Description copied from interface:IntegrationInstanceCreates a new Integration Instance.- Specified by:
createIntegrationInstancein interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteIntegrationInstance
public DeleteIntegrationInstanceResponse deleteIntegrationInstance(DeleteIntegrationInstanceRequest request)
Description copied from interface:IntegrationInstanceDeletes an Integration Instance resource by identifier.- Specified by:
deleteIntegrationInstancein interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
disasterRecoveryFailover
public DisasterRecoveryFailoverResponse disasterRecoveryFailover(DisasterRecoveryFailoverRequest request)
Description copied from interface:IntegrationInstanceAllows failover for disaster recovery.Called in the context of integration instance in that region. Upon calling the failover api in the region where given instance was created, the intigration instance if primary will be switched to standby and crossRegion integration instance will be switched to primary and vice-versa.
- Specified by:
disasterRecoveryFailoverin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
enableProcessAutomation
public EnableProcessAutomationResponse enableProcessAutomation(EnableProcessAutomationRequest request)
Description copied from interface:IntegrationInstanceEnable Process Automation for given Integration Instance- Specified by:
enableProcessAutomationin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
extendDataRetention
public ExtendDataRetentionResponse extendDataRetention(ExtendDataRetentionRequest request)
Description copied from interface:IntegrationInstanceExtend Data Retention period for given Integration Instance- Specified by:
extendDataRetentionin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getIntegrationInstance
public GetIntegrationInstanceResponse getIntegrationInstance(GetIntegrationInstanceRequest request)
Description copied from interface:IntegrationInstanceGets a IntegrationInstance by identifier- Specified by:
getIntegrationInstancein interfaceIntegrationInstance- 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:IntegrationInstanceGets the status of the work request with the given ID.- Specified by:
getWorkRequestin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listIntegrationInstances
public ListIntegrationInstancesResponse listIntegrationInstances(ListIntegrationInstancesRequest request)
Description copied from interface:IntegrationInstanceReturns a list of Integration Instances.- Specified by:
listIntegrationInstancesin interfaceIntegrationInstance- 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:IntegrationInstanceGet the errors of a work request.- Specified by:
listWorkRequestErrorsin interfaceIntegrationInstance- 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:IntegrationInstanceGet the logs of a work request.- Specified by:
listWorkRequestLogsin interfaceIntegrationInstance- 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:IntegrationInstanceLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeOracleManagedCustomEndpoint
public RemoveOracleManagedCustomEndpointResponse removeOracleManagedCustomEndpoint(RemoveOracleManagedCustomEndpointRequest request)
Description copied from interface:IntegrationInstanceRemove Oracle Managed Custom Endpoint for given integration instance that was previously enabled.- Specified by:
removeOracleManagedCustomEndpointin interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startIntegrationInstance
public StartIntegrationInstanceResponse startIntegrationInstance(StartIntegrationInstanceRequest request)
Description copied from interface:IntegrationInstanceStart an integration instance that was previously in an INACTIVE state- Specified by:
startIntegrationInstancein interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopIntegrationInstance
public StopIntegrationInstanceResponse stopIntegrationInstance(StopIntegrationInstanceRequest request)
Description copied from interface:IntegrationInstanceStop an integration instance that was previously in an ACTIVE state- Specified by:
stopIntegrationInstancein interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateIntegrationInstance
public UpdateIntegrationInstanceResponse updateIntegrationInstance(UpdateIntegrationInstanceRequest request)
Description copied from interface:IntegrationInstanceUpdates the Integration Instance.- Specified by:
updateIntegrationInstancein interfaceIntegrationInstance- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public IntegrationInstanceWaiters getWaiters()
Description copied from interface:IntegrationInstanceGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceIntegrationInstance- Returns:
- The service waiters.
-
getPaginators
public IntegrationInstancePaginators getPaginators()
Description copied from interface:IntegrationInstanceGets 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 interfaceIntegrationInstance- 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()
-
-