Class DistributedDbServiceClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.distributeddatabasev26.DistributedDbServiceClient
-
- All Implemented Interfaces:
DistributedDbService,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20260101") public class DistributedDbServiceClient extends BaseSyncClient implements DistributedDbService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDistributedDbServiceClient.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 DistributedDbService.
-
Constructor Summary
Constructors Constructor Description DistributedDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DistributedDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DistributedDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DistributedDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DistributedDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddDistributedDatabaseGdsControlNodeResponseaddDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request)Add new Global database services control(GDS CTL) node for the Globally distributed database.static DistributedDbServiceClient.Builderbuilder()Create a builder for this client.ChangeDistributedDatabaseCompartmentResponsechangeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request)Move the Globally distributed database and its dependent resources to the specified compartment.ChangeDistributedDbBackupConfigResponsechangeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request)Change the DbBackupConfig for the Globally distributed database.voidclose()ConfigureDistributedDatabaseAutoResourceManagementResponseconfigureDistributedDatabaseAutoResourceManagement(ConfigureDistributedDatabaseAutoResourceManagementRequest request)Configure autoResourceManagement options for the Globally distributed database.ConfigureDistributedDatabaseGsmsResponseconfigureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request)Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.ConfigureDistributedDatabaseShardingResponseconfigureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest request)Once all components of Globally distributed database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the Globally distributed database.CreateDistributedDatabaseResponsecreateDistributedDatabase(CreateDistributedDatabaseRequest request)Creates a Globally distributed database.DeleteDistributedDatabaseResponsedeleteDistributedDatabase(DeleteDistributedDatabaseRequest request)Terminate the given Globally distributed database.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GenerateDistributedDatabaseWalletResponsegenerateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request)Generate the wallet associated with Globally distributed database.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()GetDistributedDatabaseResponsegetDistributedDatabase(GetDistributedDatabaseRequest request)Gets the details of the Globally distributed database identified by given id.GetDistributedDatabaseRaftMetricResponsegetDistributedDatabaseRaftMetric(GetDistributedDatabaseRaftMetricRequest request)Operation to retrieve RAFT metrics for the Globally distributed database.GetDistributedDatabaseRuChangeLogResponsegetDistributedDatabaseRuChangeLog(GetDistributedDatabaseRuChangeLogRequest request)Operation to retrieve move RU invocation history and status for the Globally distributed database.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.DistributedDbServicePaginatorsgetPaginators()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.DistributedDbServiceWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListDistributedDatabasesResponselistDistributedDatabases(ListDistributedDatabasesRequest request)List of Globally distributed databases.MoveDistributedDatabaseReplicationUnitResponsemoveDistributedDatabaseReplicationUnit(MoveDistributedDatabaseReplicationUnitRequest request)Move the replication units for RAFT based globally distributed database from source shard to destination shard.PatchDistributedDatabaseResponsepatchDistributedDatabase(PatchDistributedDatabaseRequest request)Patch operation to add, remove or update shards to the Globally distributed database topology.RecreateFailedDistributedDatabaseResourceResponserecreateFailedDistributedDatabaseResource(RecreateFailedDistributedDatabaseResourceRequest request)Recreate the failed resource for the Globally Distributed Database.voidrefreshClient()Rebuild the backingHttpClient.RotateDistributedDatabasePasswordsResponserotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request)Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed database.ScaleDistributedDatabaseGsmsResponsescaleDistributedDatabaseGsms(ScaleDistributedDatabaseGsmsRequest request)Scale global service manager(GSM aka shard manager) instances for the Globally distributed database.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’).StartDistributedDatabaseResponsestartDistributedDatabase(StartDistributedDatabaseRequest request)Start the shards, catalog, GSMs and GDSCTL instances of Globally distributed database.StopDistributedDatabaseResponsestopDistributedDatabase(StopDistributedDatabaseRequest request)Stop the shards, catalog, GSMs and GDSCTL instances for the Globally distributed database.UpdateDistributedDatabaseResponseupdateDistributedDatabase(UpdateDistributedDatabaseRequest request)Updates the configuration of the Globally distributed database.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.ValidateDistributedDatabaseNetworkResponsevalidateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request)Validate the network connectivity between components of the globally distributed database.-
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.distributeddatabasev26.DistributedDbService
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDistributedDbServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(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 (seeDistributedDbServiceClient.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)
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(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 (seeDistributedDbServiceClient.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
-
DistributedDbServiceClient
@Deprecated public DistributedDbServiceClient(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 (seeDistributedDbServiceClient.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-DistributedDbServiceClient.Builder.executorService
-
-
Method Detail
-
builder
public static DistributedDbServiceClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DistributedDbServiceSets 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 interfaceDistributedDbService- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DistributedDbServiceSets 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 interfaceDistributedDbService- Parameters:
regionId- The public region ID.
-
addDistributedDatabaseGdsControlNode
public AddDistributedDatabaseGdsControlNodeResponse addDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request)
Description copied from interface:DistributedDbServiceAdd new Global database services control(GDS CTL) node for the Globally distributed database.- Specified by:
addDistributedDatabaseGdsControlNodein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDistributedDatabaseCompartment
public ChangeDistributedDatabaseCompartmentResponse changeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request)
Description copied from interface:DistributedDbServiceMove the Globally distributed database and its dependent resources to the specified compartment.- Specified by:
changeDistributedDatabaseCompartmentin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDistributedDbBackupConfig
public ChangeDistributedDbBackupConfigResponse changeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request)
Description copied from interface:DistributedDbServiceChange the DbBackupConfig for the Globally distributed database.- Specified by:
changeDistributedDbBackupConfigin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
configureDistributedDatabaseAutoResourceManagement
public ConfigureDistributedDatabaseAutoResourceManagementResponse configureDistributedDatabaseAutoResourceManagement(ConfigureDistributedDatabaseAutoResourceManagementRequest request)
Description copied from interface:DistributedDbServiceConfigure autoResourceManagement options for the Globally distributed database.- Specified by:
configureDistributedDatabaseAutoResourceManagementin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
configureDistributedDatabaseGsms
public ConfigureDistributedDatabaseGsmsResponse configureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request)
Description copied from interface:DistributedDbServiceConfigure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.- Specified by:
configureDistributedDatabaseGsmsin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
configureDistributedDatabaseSharding
public ConfigureDistributedDatabaseShardingResponse configureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest request)
Description copied from interface:DistributedDbServiceOnce all components of Globally distributed database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the Globally distributed database.Note that this ‘ConfigureSharding’ API also needs to be invoked after successfully adding a new shard to the Globally distributed database using PATCH api. If this API is not invoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology of the Globally distributed database.
- Specified by:
configureDistributedDatabaseShardingin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDistributedDatabase
public CreateDistributedDatabaseResponse createDistributedDatabase(CreateDistributedDatabaseRequest request)
Description copied from interface:DistributedDbServiceCreates a Globally distributed database.- Specified by:
createDistributedDatabasein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDistributedDatabase
public DeleteDistributedDatabaseResponse deleteDistributedDatabase(DeleteDistributedDatabaseRequest request)
Description copied from interface:DistributedDbServiceTerminate the given Globally distributed database.- Specified by:
deleteDistributedDatabasein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateDistributedDatabaseWallet
public GenerateDistributedDatabaseWalletResponse generateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request)
Description copied from interface:DistributedDbServiceGenerate the wallet associated with Globally distributed database.- Specified by:
generateDistributedDatabaseWalletin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDistributedDatabase
public GetDistributedDatabaseResponse getDistributedDatabase(GetDistributedDatabaseRequest request)
Description copied from interface:DistributedDbServiceGets the details of the Globally distributed database identified by given id.- Specified by:
getDistributedDatabasein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDistributedDatabaseRaftMetric
public GetDistributedDatabaseRaftMetricResponse getDistributedDatabaseRaftMetric(GetDistributedDatabaseRaftMetricRequest request)
Description copied from interface:DistributedDbServiceOperation to retrieve RAFT metrics for the Globally distributed database.If the Globally distributed database is not RAFT based then empty response is returned from the API.
- Specified by:
getDistributedDatabaseRaftMetricin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDistributedDatabaseRuChangeLog
public GetDistributedDatabaseRuChangeLogResponse getDistributedDatabaseRuChangeLog(GetDistributedDatabaseRuChangeLogRequest request)
Description copied from interface:DistributedDbServiceOperation to retrieve move RU invocation history and status for the Globally distributed database.Results are ordered by created timestamp in descending order.
- Specified by:
getDistributedDatabaseRuChangeLogin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDistributedDatabases
public ListDistributedDatabasesResponse listDistributedDatabases(ListDistributedDatabasesRequest request)
Description copied from interface:DistributedDbServiceList of Globally distributed databases.- Specified by:
listDistributedDatabasesin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
moveDistributedDatabaseReplicationUnit
public MoveDistributedDatabaseReplicationUnitResponse moveDistributedDatabaseReplicationUnit(MoveDistributedDatabaseReplicationUnitRequest request)
Description copied from interface:DistributedDbServiceMove the replication units for RAFT based globally distributed database from source shard to destination shard.- Specified by:
moveDistributedDatabaseReplicationUnitin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchDistributedDatabase
public PatchDistributedDatabaseResponse patchDistributedDatabase(PatchDistributedDatabaseRequest request)
Description copied from interface:DistributedDbServicePatch operation to add, remove or update shards to the Globally distributed database topology.In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.
- Specified by:
patchDistributedDatabasein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
recreateFailedDistributedDatabaseResource
public RecreateFailedDistributedDatabaseResourceResponse recreateFailedDistributedDatabaseResource(RecreateFailedDistributedDatabaseResourceRequest request)
Description copied from interface:DistributedDbServiceRecreate the failed resource for the Globally Distributed Database.- Specified by:
recreateFailedDistributedDatabaseResourcein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
rotateDistributedDatabasePasswords
public RotateDistributedDatabasePasswordsResponse rotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request)
Description copied from interface:DistributedDbServiceRotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed database.This operation will also remove GdsCtlNodes if present.
- Specified by:
rotateDistributedDatabasePasswordsin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scaleDistributedDatabaseGsms
public ScaleDistributedDatabaseGsmsResponse scaleDistributedDatabaseGsms(ScaleDistributedDatabaseGsmsRequest request)
Description copied from interface:DistributedDbServiceScale global service manager(GSM aka shard manager) instances for the Globally distributed database.- Specified by:
scaleDistributedDatabaseGsmsin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startDistributedDatabase
public StartDistributedDatabaseResponse startDistributedDatabase(StartDistributedDatabaseRequest request)
Description copied from interface:DistributedDbServiceStart the shards, catalog, GSMs and GDSCTL instances of Globally distributed database.- Specified by:
startDistributedDatabasein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopDistributedDatabase
public StopDistributedDatabaseResponse stopDistributedDatabase(StopDistributedDatabaseRequest request)
Description copied from interface:DistributedDbServiceStop the shards, catalog, GSMs and GDSCTL instances for the Globally distributed database.- Specified by:
stopDistributedDatabasein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDistributedDatabase
public UpdateDistributedDatabaseResponse updateDistributedDatabase(UpdateDistributedDatabaseRequest request)
Description copied from interface:DistributedDbServiceUpdates the configuration of the Globally distributed database.- Specified by:
updateDistributedDatabasein interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateDistributedDatabaseNetwork
public ValidateDistributedDatabaseNetworkResponse validateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request)
Description copied from interface:DistributedDbServiceValidate the network connectivity between components of the globally distributed database.- Specified by:
validateDistributedDatabaseNetworkin interfaceDistributedDbService- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DistributedDbServiceWaiters getWaiters()
Description copied from interface:DistributedDbServiceGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDistributedDbService- Returns:
- The service waiters.
-
getPaginators
public DistributedDbServicePaginators getPaginators()
Description copied from interface:DistributedDbServiceGets 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 interfaceDistributedDbService- 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()
-
-