Class ManagedMySqlDatabasesAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.databasemanagement.ManagedMySqlDatabasesAsyncClient
-
- All Implemented Interfaces:
ManagedMySqlDatabasesAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20201101") public class ManagedMySqlDatabasesAsyncClient extends BaseAsyncClient implements ManagedMySqlDatabasesAsyncAsync client implementation for ManagedMySqlDatabases service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classManagedMySqlDatabasesAsyncClient.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 ManagedMySqlDatabases.
-
Constructor Summary
Constructors Constructor Description ManagedMySqlDatabasesAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ManagedMySqlDatabasesAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ManagedMySqlDatabasesAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ManagedMySqlDatabasesAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ManagedMySqlDatabasesAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ManagedMySqlDatabasesAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ManagedMySqlDatabasesAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.databasemanagement.ManagedMySqlDatabasesAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ManagedMySqlDatabasesAsyncClient
@Deprecated public ManagedMySqlDatabasesAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagedMySqlDatabasesAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
ManagedMySqlDatabasesAsyncClient
@Deprecated public ManagedMySqlDatabasesAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagedMySqlDatabasesAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
ManagedMySqlDatabasesAsyncClient
@Deprecated public ManagedMySqlDatabasesAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagedMySqlDatabasesAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ManagedMySqlDatabasesAsyncClient
@Deprecated public ManagedMySqlDatabasesAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagedMySqlDatabasesAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
ManagedMySqlDatabasesAsyncClient
@Deprecated public ManagedMySqlDatabasesAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeManagedMySqlDatabasesAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ManagedMySqlDatabasesAsyncClient
@Deprecated public ManagedMySqlDatabasesAsyncClient(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 (seeManagedMySqlDatabasesAsyncClient.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)
-
ManagedMySqlDatabasesAsyncClient
@Deprecated public ManagedMySqlDatabasesAsyncClient(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 (seeManagedMySqlDatabasesAsyncClient.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
-
-
Method Detail
-
builder
public static ManagedMySqlDatabasesAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ManagedMySqlDatabasesAsyncSets 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 interfaceManagedMySqlDatabasesAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ManagedMySqlDatabasesAsyncSets 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 interfaceManagedMySqlDatabasesAsync- Parameters:
regionId- The public region ID.
-
changeMysqlDatabaseManagementType
public Future<ChangeMysqlDatabaseManagementTypeResponse> changeMysqlDatabaseManagementType(ChangeMysqlDatabaseManagementTypeRequest request, AsyncHandler<ChangeMysqlDatabaseManagementTypeRequest,ChangeMysqlDatabaseManagementTypeResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncChanges the management type for a HeatWave MySQL instance, from BASIC to FULL and vice versa.It can also be used to enable or disable database management.
- Specified by:
changeMysqlDatabaseManagementTypein interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBinaryLogInformation
public Future<GetBinaryLogInformationResponse> getBinaryLogInformation(GetBinaryLogInformationRequest request, AsyncHandler<GetBinaryLogInformationRequest,GetBinaryLogInformationResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves information pertaining to the binary log of a specific MySQL server.- Specified by:
getBinaryLogInformationin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getGeneralReplicationInformation
public Future<GetGeneralReplicationInformationResponse> getGeneralReplicationInformation(GetGeneralReplicationInformationRequest request, AsyncHandler<GetGeneralReplicationInformationRequest,GetGeneralReplicationInformationResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves general information regarding the replication of a specific MySQL server.- Specified by:
getGeneralReplicationInformationin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getHeatWaveFleetMetric
public Future<GetHeatWaveFleetMetricResponse> getHeatWaveFleetMetric(GetHeatWaveFleetMetricRequest request, AsyncHandler<GetHeatWaveFleetMetricRequest,GetHeatWaveFleetMetricResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncGets the health metrics for a fleet of HeatWave clusters in a compartment.- Specified by:
getHeatWaveFleetMetricin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getManagedMySqlDatabase
public Future<GetManagedMySqlDatabaseResponse> getManagedMySqlDatabase(GetManagedMySqlDatabaseRequest request, AsyncHandler<GetManagedMySqlDatabaseRequest,GetManagedMySqlDatabaseResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves the general information for a specific MySQL Database.- Specified by:
getManagedMySqlDatabasein interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getMySqlFleetMetric
public Future<GetMySqlFleetMetricResponse> getMySqlFleetMetric(GetMySqlFleetMetricRequest request, AsyncHandler<GetMySqlFleetMetricRequest,GetMySqlFleetMetricResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncGets the health metrics for a fleet of MySQL Databases in a compartment.- Specified by:
getMySqlFleetMetricin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getMySqlQueryDetails
public Future<GetMySqlQueryDetailsResponse> getMySqlQueryDetails(GetMySqlQueryDetailsRequest request, AsyncHandler<GetMySqlQueryDetailsRequest,GetMySqlQueryDetailsResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves query sample details, explain plan and potential warnings for a given digest.- Specified by:
getMySqlQueryDetailsin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listHighAvailabilityMembers
public Future<ListHighAvailabilityMembersResponse> listHighAvailabilityMembers(ListHighAvailabilityMembersRequest request, AsyncHandler<ListHighAvailabilityMembersRequest,ListHighAvailabilityMembersResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves information about the high availability members of a specific MySQL server’s replication group.- Specified by:
listHighAvailabilityMembersin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listInboundReplications
public Future<ListInboundReplicationsResponse> listInboundReplications(ListInboundReplicationsRequest request, AsyncHandler<ListInboundReplicationsRequest,ListInboundReplicationsResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves information about the inbound replications of a specific MySQL server.- Specified by:
listInboundReplicationsin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedMySqlDatabaseConfigurationData
public Future<ListManagedMySqlDatabaseConfigurationDataResponse> listManagedMySqlDatabaseConfigurationData(ListManagedMySqlDatabaseConfigurationDataRequest request, AsyncHandler<ListManagedMySqlDatabaseConfigurationDataRequest,ListManagedMySqlDatabaseConfigurationDataResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves configuration data for a specific MySQL database.- Specified by:
listManagedMySqlDatabaseConfigurationDatain interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedMySqlDatabaseSqlData
public Future<ListManagedMySqlDatabaseSqlDataResponse> listManagedMySqlDatabaseSqlData(ListManagedMySqlDatabaseSqlDataRequest request, AsyncHandler<ListManagedMySqlDatabaseSqlDataRequest,ListManagedMySqlDatabaseSqlDataResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves the SQL performance data for a specific MySQL database.- Specified by:
listManagedMySqlDatabaseSqlDatain interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedMySqlDatabases
public Future<ListManagedMySqlDatabasesResponse> listManagedMySqlDatabases(ListManagedMySqlDatabasesRequest request, AsyncHandler<ListManagedMySqlDatabasesRequest,ListManagedMySqlDatabasesResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncGets the list of Managed MySQL Databases in a specific compartment.- Specified by:
listManagedMySqlDatabasesin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listMySqlDigestErrors
public Future<ListMySqlDigestErrorsResponse> listMySqlDigestErrors(ListMySqlDigestErrorsRequest request, AsyncHandler<ListMySqlDigestErrorsRequest,ListMySqlDigestErrorsResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves any potential errors for a given digest.- Specified by:
listMySqlDigestErrorsin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listOutboundReplications
public Future<ListOutboundReplicationsResponse> listOutboundReplications(ListOutboundReplicationsRequest request, AsyncHandler<ListOutboundReplicationsRequest,ListOutboundReplicationsResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncRetrieves information pertaining to the outbound replications of a specific MySQL server.- Specified by:
listOutboundReplicationsin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
summarizeManagedMySqlDatabaseAvailabilityMetrics
public Future<SummarizeManagedMySqlDatabaseAvailabilityMetricsResponse> summarizeManagedMySqlDatabaseAvailabilityMetrics(SummarizeManagedMySqlDatabaseAvailabilityMetricsRequest request, AsyncHandler<SummarizeManagedMySqlDatabaseAvailabilityMetricsRequest,SummarizeManagedMySqlDatabaseAvailabilityMetricsResponse> handler)
Description copied from interface:ManagedMySqlDatabasesAsyncGets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.- Specified by:
summarizeManagedMySqlDatabaseAvailabilityMetricsin interfaceManagedMySqlDatabasesAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
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()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-