Class DbMulticloudAwsProviderClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.dbmulticloud.DbMulticloudAwsProviderClient
-
- All Implemented Interfaces:
DbMulticloudAwsProvider,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20240501") public class DbMulticloudAwsProviderClient extends BaseSyncClient implements DbMulticloudAwsProvider
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDbMulticloudAwsProviderClient.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 DbMulticloudAwsProvider.
-
Constructor Summary
Constructors Constructor Description DbMulticloudAwsProviderClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DbMulticloudAwsProviderClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DbMulticloudAwsProviderClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DbMulticloudAwsProviderClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DbMulticloudAwsProviderClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DbMulticloudAwsProviderClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DbMulticloudAwsProviderClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DbMulticloudAwsProviderClient(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 DbMulticloudAwsProviderClient.Builderbuilder()Create a builder for this client.ChangeOracleDbAwsIdentityConnectorCompartmentResponsechangeOracleDbAwsIdentityConnectorCompartment(ChangeOracleDbAwsIdentityConnectorCompartmentRequest request)Moves the Oracle DB AWS Identity Connector resource into a different compartment.ChangeOracleDbAwsKeyCompartmentResponsechangeOracleDbAwsKeyCompartment(ChangeOracleDbAwsKeyCompartmentRequest request)Moves the AWS Key resource into a different compartment.voidclose()CreateOracleDbAwsIdentityConnectorResponsecreateOracleDbAwsIdentityConnector(CreateOracleDbAwsIdentityConnectorRequest request)Creates Oracle DB AWS Identity Connector resource.CreateOracleDbAwsKeyResponsecreateOracleDbAwsKey(CreateOracleDbAwsKeyRequest request)Create DB AWS Key resource.DeleteOracleDbAwsIdentityConnectorResponsedeleteOracleDbAwsIdentityConnector(DeleteOracleDbAwsIdentityConnectorRequest request)Deletes a Oracle DB AWS Identity Connector resource.DeleteOracleDbAwsKeyResponsedeleteOracleDbAwsKey(DeleteOracleDbAwsKeyRequest request)Delete AWS Key resource.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.GetOracleDbAwsIdentityConnectorResponsegetOracleDbAwsIdentityConnector(GetOracleDbAwsIdentityConnectorRequest request)Retrieves detailed information about a Oracle DB AWS Identity Connector resource by specifying its unique resource OCID.GetOracleDbAwsKeyResponsegetOracleDbAwsKey(GetOracleDbAwsKeyRequest request)Retrieves detailed information about a Oracle AWS Key resource by specifying its unique resource OCID.DbMulticloudAwsProviderPaginatorsgetPaginators()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.DbMulticloudAwsProviderWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListOracleDbAwsIdentityConnectorsResponselistOracleDbAwsIdentityConnectors(ListOracleDbAwsIdentityConnectorsRequest request)Lists all Oracle DB AWS Identity Connectors based on the specified filters.ListOracleDbAwsKeysResponselistOracleDbAwsKeys(ListOracleDbAwsKeysRequest request)Lists all DB AWS Keys based on the specified filters.voidrefreshClient()Rebuild the backingHttpClient.RefreshOracleDbAwsIdentityConnectorResponserefreshOracleDbAwsIdentityConnector(RefreshOracleDbAwsIdentityConnectorRequest request)Refreshes the Oracle DB AWS Connector resource.RefreshOracleDbAwsKeyResponserefreshOracleDbAwsKey(RefreshOracleDbAwsKeyRequest request)Refreshes Oracle AWS Key resource.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’).UpdateOracleDbAwsIdentityConnectorResponseupdateOracleDbAwsIdentityConnector(UpdateOracleDbAwsIdentityConnectorRequest request)Modifies the existing Oracle DB AWS Identity Connector resource for a given OCID.UpdateOracleDbAwsKeyResponseupdateOracleDbAwsKey(UpdateOracleDbAwsKeyRequest request)Modifies the existing Oracle AWS Key Details for a given OCID.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.dbmulticloud.DbMulticloudAwsProvider
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbMulticloudAwsProviderClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbMulticloudAwsProviderClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbMulticloudAwsProviderClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbMulticloudAwsProviderClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDbMulticloudAwsProviderClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(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 (seeDbMulticloudAwsProviderClient.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)
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(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 (seeDbMulticloudAwsProviderClient.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
-
DbMulticloudAwsProviderClient
@Deprecated public DbMulticloudAwsProviderClient(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 (seeDbMulticloudAwsProviderClient.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-DbMulticloudAwsProviderClient.Builder.executorService
-
-
Method Detail
-
builder
public static DbMulticloudAwsProviderClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DbMulticloudAwsProviderSets 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 interfaceDbMulticloudAwsProvider- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DbMulticloudAwsProviderSets 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 interfaceDbMulticloudAwsProvider- Parameters:
regionId- The public region ID.
-
changeOracleDbAwsIdentityConnectorCompartment
public ChangeOracleDbAwsIdentityConnectorCompartmentResponse changeOracleDbAwsIdentityConnectorCompartment(ChangeOracleDbAwsIdentityConnectorCompartmentRequest request)
Description copied from interface:DbMulticloudAwsProviderMoves the Oracle DB AWS Identity Connector resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
- Specified by:
changeOracleDbAwsIdentityConnectorCompartmentin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeOracleDbAwsKeyCompartment
public ChangeOracleDbAwsKeyCompartmentResponse changeOracleDbAwsKeyCompartment(ChangeOracleDbAwsKeyCompartmentRequest request)
Description copied from interface:DbMulticloudAwsProviderMoves the AWS Key resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
- Specified by:
changeOracleDbAwsKeyCompartmentin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOracleDbAwsIdentityConnector
public CreateOracleDbAwsIdentityConnectorResponse createOracleDbAwsIdentityConnector(CreateOracleDbAwsIdentityConnectorRequest request)
Description copied from interface:DbMulticloudAwsProviderCreates Oracle DB AWS Identity Connector resource.- Specified by:
createOracleDbAwsIdentityConnectorin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOracleDbAwsKey
public CreateOracleDbAwsKeyResponse createOracleDbAwsKey(CreateOracleDbAwsKeyRequest request)
Description copied from interface:DbMulticloudAwsProviderCreate DB AWS Key resource.- Specified by:
createOracleDbAwsKeyin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOracleDbAwsIdentityConnector
public DeleteOracleDbAwsIdentityConnectorResponse deleteOracleDbAwsIdentityConnector(DeleteOracleDbAwsIdentityConnectorRequest request)
Description copied from interface:DbMulticloudAwsProviderDeletes a Oracle DB AWS Identity Connector resource.- Specified by:
deleteOracleDbAwsIdentityConnectorin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOracleDbAwsKey
public DeleteOracleDbAwsKeyResponse deleteOracleDbAwsKey(DeleteOracleDbAwsKeyRequest request)
Description copied from interface:DbMulticloudAwsProviderDelete AWS Key resource.- Specified by:
deleteOracleDbAwsKeyin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOracleDbAwsIdentityConnector
public GetOracleDbAwsIdentityConnectorResponse getOracleDbAwsIdentityConnector(GetOracleDbAwsIdentityConnectorRequest request)
Description copied from interface:DbMulticloudAwsProviderRetrieves detailed information about a Oracle DB AWS Identity Connector resource by specifying its unique resource OCID.- Specified by:
getOracleDbAwsIdentityConnectorin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOracleDbAwsKey
public GetOracleDbAwsKeyResponse getOracleDbAwsKey(GetOracleDbAwsKeyRequest request)
Description copied from interface:DbMulticloudAwsProviderRetrieves detailed information about a Oracle AWS Key resource by specifying its unique resource OCID.- Specified by:
getOracleDbAwsKeyin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOracleDbAwsIdentityConnectors
public ListOracleDbAwsIdentityConnectorsResponse listOracleDbAwsIdentityConnectors(ListOracleDbAwsIdentityConnectorsRequest request)
Description copied from interface:DbMulticloudAwsProviderLists all Oracle DB AWS Identity Connectors based on the specified filters.- Specified by:
listOracleDbAwsIdentityConnectorsin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOracleDbAwsKeys
public ListOracleDbAwsKeysResponse listOracleDbAwsKeys(ListOracleDbAwsKeysRequest request)
Description copied from interface:DbMulticloudAwsProviderLists all DB AWS Keys based on the specified filters.- Specified by:
listOracleDbAwsKeysin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshOracleDbAwsIdentityConnector
public RefreshOracleDbAwsIdentityConnectorResponse refreshOracleDbAwsIdentityConnector(RefreshOracleDbAwsIdentityConnectorRequest request)
Description copied from interface:DbMulticloudAwsProviderRefreshes the Oracle DB AWS Connector resource.- Specified by:
refreshOracleDbAwsIdentityConnectorin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshOracleDbAwsKey
public RefreshOracleDbAwsKeyResponse refreshOracleDbAwsKey(RefreshOracleDbAwsKeyRequest request)
Description copied from interface:DbMulticloudAwsProviderRefreshes Oracle AWS Key resource.- Specified by:
refreshOracleDbAwsKeyin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOracleDbAwsIdentityConnector
public UpdateOracleDbAwsIdentityConnectorResponse updateOracleDbAwsIdentityConnector(UpdateOracleDbAwsIdentityConnectorRequest request)
Description copied from interface:DbMulticloudAwsProviderModifies the existing Oracle DB AWS Identity Connector resource for a given OCID.- Specified by:
updateOracleDbAwsIdentityConnectorin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOracleDbAwsKey
public UpdateOracleDbAwsKeyResponse updateOracleDbAwsKey(UpdateOracleDbAwsKeyRequest request)
Description copied from interface:DbMulticloudAwsProviderModifies the existing Oracle AWS Key Details for a given OCID.- Specified by:
updateOracleDbAwsKeyin interfaceDbMulticloudAwsProvider- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DbMulticloudAwsProviderWaiters getWaiters()
Description copied from interface:DbMulticloudAwsProviderGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDbMulticloudAwsProvider- Returns:
- The service waiters.
-
getPaginators
public DbMulticloudAwsProviderPaginators getPaginators()
Description copied from interface:DbMulticloudAwsProviderGets 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 interfaceDbMulticloudAwsProvider- 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()
-
-