Package com.oracle.bmc.globallydistributeddatabase

Class ShardedDatabaseServiceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.globallydistributeddatabase.ShardedDatabaseServiceClient

All Implemented Interfaces:

ShardedDatabaseService, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230301")
public class ShardedDatabaseServiceClient
extends BaseSyncClient
implements ShardedDatabaseService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShardedDatabaseServiceClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for ShardedDatabaseService.

Constructor Summary

Constructors

Constructor	Description
ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
ShardedDatabaseServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
ShardedDatabaseServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
ShardedDatabaseServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static ShardedDatabaseServiceClient.Builder	builder()	Create a builder for this client.
ChangePrivateEndpointCompartmentResponse	changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)	Move the private endpoint to the specified compartment.
ChangeShardedDatabaseCompartmentResponse	changeShardedDatabaseCompartment(ChangeShardedDatabaseCompartmentRequest request)	Move the sharded database database and its dependent resources to the specified compartment.
void	close()
ConfigureShardedDatabaseGsmsResponse	configureShardedDatabaseGsms(ConfigureShardedDatabaseGsmsRequest request)	Configure new Global Service Manager(GSM aka shard manager) instances for the sharded database.
ConfigureShardingResponse	configureSharding(ConfigureShardingRequest request)	Once all components of sharded database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the sharded database.
CreatePrivateEndpointResponse	createPrivateEndpoint(CreatePrivateEndpointRequest request)	Creates a PrivateEndpoint.
CreateShardedDatabaseResponse	createShardedDatabase(CreateShardedDatabaseRequest request)	Creates a Sharded Database.
DeletePrivateEndpointResponse	deletePrivateEndpoint(DeletePrivateEndpointRequest request)	Delete the given private endpoint.
DeleteShardedDatabaseResponse	deleteShardedDatabase(DeleteShardedDatabaseRequest request)	Terminate the given sharded databases.
DownloadGsmCertificateSigningRequestResponse	downloadGsmCertificateSigningRequest(DownloadGsmCertificateSigningRequestRequest request)	Generate the common certificate signing request for GSMs.
FetchConnectionStringResponse	fetchConnectionString(FetchConnectionStringRequest request)	Gets the Sharded Database Connection Strings.
FetchShardableCloudAutonomousVmClustersResponse	fetchShardableCloudAutonomousVmClusters(FetchShardableCloudAutonomousVmClustersRequest request)	List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.
GenerateGsmCertificateSigningRequestResponse	generateGsmCertificateSigningRequest(GenerateGsmCertificateSigningRequestRequest request)	Generate the certificate signing request for GSM instances of the sharded database.
GenerateWalletResponse	generateWallet(GenerateWalletRequest request)	Generate the wallet associated with sharded database.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ShardedDatabaseServicePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPrivateEndpointResponse	getPrivateEndpoint(GetPrivateEndpointRequest request)	Get the PrivateEndpoint resource.
GetShardedDatabaseResponse	getShardedDatabase(GetShardedDatabaseRequest request)	Gets the details of the Sharded database identified by given id.
ShardedDatabaseServiceWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets details of the work request with the given ID.
ListPrivateEndpointsResponse	listPrivateEndpoints(ListPrivateEndpointsRequest request)	List of PrivateEndpoints.
ListShardedDatabasesResponse	listShardedDatabases(ListShardedDatabasesRequest request)	List of Sharded databases.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Returns a (paginated) list of errors for the work request with the given ID.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Returns a (paginated) list of logs for the work request with the given ID.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	Lists the work requests in a compartment.
PatchShardedDatabaseResponse	patchShardedDatabase(PatchShardedDatabaseRequest request)	Patch operation to add, remove or update shards to the sharded database topology.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PrevalidateShardedDatabaseResponse	prevalidateShardedDatabase(PrevalidateShardedDatabaseRequest request)	Sharded database pre-validation request.
void	refreshClient()	Rebuild the backing HttpClient.
ReinstateProxyInstanceResponse	reinstateProxyInstance(ReinstateProxyInstanceRequest request)	API to reinstate the proxy instances associated with the private endpoint.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
StartShardedDatabaseResponse	startShardedDatabase(StartShardedDatabaseRequest request)	Start the shards, catalog and GSMs of Sharded Database.
StopShardedDatabaseResponse	stopShardedDatabase(StopShardedDatabaseRequest request)	Stop the shards, catalog and GSM instances for the sharded database.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdatePrivateEndpointResponse	updatePrivateEndpoint(UpdatePrivateEndpointRequest request)	Updates the configuration of privateendpoint.
UpdateShardedDatabaseResponse	updateShardedDatabase(UpdateShardedDatabaseRequest request)	Updates the configuration of sharded database.
UploadSignedCertificateAndGenerateWalletResponse	uploadSignedCertificateAndGenerateWallet(UploadSignedCertificateAndGenerateWalletRequest request)	Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the sharded database.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
ValidateNetworkResponse	validateNetwork(ValidateNetworkRequest request)	Validate the network connectivity between components of sharded 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.globallydistributeddatabase.ShardedDatabaseService

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ShardedDatabaseService.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

ShardedDatabaseServiceClient

@Deprecated
public ShardedDatabaseServiceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint,
                                    ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ShardedDatabaseServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - ShardedDatabaseServiceClient.Builder.executorService

Method Detail

builder

public static ShardedDatabaseServiceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ShardedDatabaseService

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface ShardedDatabaseService

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ShardedDatabaseService

Sets 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 call setEndpoint.

Specified by:

setRegion in interface ShardedDatabaseService

Parameters:

regionId - The public region ID.

changePrivateEndpointCompartment

public ChangePrivateEndpointCompartmentResponse changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)

Description copied from interface: ShardedDatabaseService

Move the private endpoint to the specified compartment.

Specified by:

changePrivateEndpointCompartment in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeShardedDatabaseCompartment

public ChangeShardedDatabaseCompartmentResponse changeShardedDatabaseCompartment(ChangeShardedDatabaseCompartmentRequest request)

Description copied from interface: ShardedDatabaseService

Move the sharded database database and its dependent resources to the specified compartment.

Specified by:

changeShardedDatabaseCompartment in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureShardedDatabaseGsms

public ConfigureShardedDatabaseGsmsResponse configureShardedDatabaseGsms(ConfigureShardedDatabaseGsmsRequest request)

Description copied from interface: ShardedDatabaseService

Configure new Global Service Manager(GSM aka shard manager) instances for the sharded database.

Specify the names of old GSM instances that need to be replaced via parameter oldGsmNames in the request payload. Also specify whether rotated GSM instances shall be provisioned with latest image of GSM software or the image used by existing GSM instances shall be used.

Specified by:

configureShardedDatabaseGsms in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

configureSharding

public ConfigureShardingResponse configureSharding(ConfigureShardingRequest request)

Description copied from interface: ShardedDatabaseService

Once all components of sharded database are provisioned, and signed GSM certificates are successfully uploaded, this api shall be invoked to configure sharding on the sharded database.

Note that this ‘ConfigureSharding’ API also needs to be invoked after successfully adding a new shard to the sharded 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 sharded database.

Specified by:

configureSharding in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPrivateEndpoint

public CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)

Description copied from interface: ShardedDatabaseService

Creates a PrivateEndpoint.

Specified by:

createPrivateEndpoint in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createShardedDatabase

public CreateShardedDatabaseResponse createShardedDatabase(CreateShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Creates a Sharded Database.

Specified by:

createShardedDatabase in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePrivateEndpoint

public DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)

Description copied from interface: ShardedDatabaseService

Delete the given private endpoint.

Specified by:

deletePrivateEndpoint in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteShardedDatabase

public DeleteShardedDatabaseResponse deleteShardedDatabase(DeleteShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Terminate the given sharded databases.

Specified by:

deleteShardedDatabase in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

downloadGsmCertificateSigningRequest

public DownloadGsmCertificateSigningRequestResponse downloadGsmCertificateSigningRequest(DownloadGsmCertificateSigningRequestRequest request)

Description copied from interface: ShardedDatabaseService

Generate the common certificate signing request for GSMs.

Download the .csr file from API response. Users can use this .csr file to generate the CA signed certificate, and as a next step use ‘uploadSignedCertificateAndGenerateWallet’ API to upload the CA signed certificate to GSM, and generate wallets for the GSM instances of the sharded database.

Specified by:

downloadGsmCertificateSigningRequest in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

fetchConnectionString

public FetchConnectionStringResponse fetchConnectionString(FetchConnectionStringRequest request)

Description copied from interface: ShardedDatabaseService

Gets the Sharded Database Connection Strings.

Specified by:

fetchConnectionString in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

fetchShardableCloudAutonomousVmClusters

public FetchShardableCloudAutonomousVmClustersResponse fetchShardableCloudAutonomousVmClusters(FetchShardableCloudAutonomousVmClustersRequest request)

Description copied from interface: ShardedDatabaseService

List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.

Specified by:

fetchShardableCloudAutonomousVmClusters in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateGsmCertificateSigningRequest

public GenerateGsmCertificateSigningRequestResponse generateGsmCertificateSigningRequest(GenerateGsmCertificateSigningRequestRequest request)

Description copied from interface: ShardedDatabaseService

Generate the certificate signing request for GSM instances of the sharded database.

Once certificate signing request is generated, then customers can download the certificate signing request using ‘downloadGsmCertificateSigningRequest’ api call.

Specified by:

generateGsmCertificateSigningRequest in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateWallet

public GenerateWalletResponse generateWallet(GenerateWalletRequest request)

Description copied from interface: ShardedDatabaseService

Generate the wallet associated with sharded database.

Specified by:

generateWallet in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivateEndpoint

public GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)

Description copied from interface: ShardedDatabaseService

Get the PrivateEndpoint resource.

Specified by:

getPrivateEndpoint in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getShardedDatabase

public GetShardedDatabaseResponse getShardedDatabase(GetShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Gets the details of the Sharded database identified by given id.

Specified by:

getShardedDatabase in interface ShardedDatabaseService

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: ShardedDatabaseService

Gets details of the work request with the given ID.

Specified by:

getWorkRequest in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPrivateEndpoints

public ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)

Description copied from interface: ShardedDatabaseService

List of PrivateEndpoints.

Specified by:

listPrivateEndpoints in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listShardedDatabases

public ListShardedDatabasesResponse listShardedDatabases(ListShardedDatabasesRequest request)

Description copied from interface: ShardedDatabaseService

List of Sharded databases.

Specified by:

listShardedDatabases in interface ShardedDatabaseService

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: ShardedDatabaseService

Returns a (paginated) list of errors for the work request with the given ID.

Specified by:

listWorkRequestErrors in interface ShardedDatabaseService

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: ShardedDatabaseService

Returns a (paginated) list of logs for the work request with the given ID.

Specified by:

listWorkRequestLogs in interface ShardedDatabaseService

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: ShardedDatabaseService

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

patchShardedDatabase

public PatchShardedDatabaseResponse patchShardedDatabase(PatchShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Patch operation to add, remove or update shards to the sharded 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:

patchShardedDatabase in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

prevalidateShardedDatabase

public PrevalidateShardedDatabaseResponse prevalidateShardedDatabase(PrevalidateShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Sharded database pre-validation request.

Specified by:

prevalidateShardedDatabase in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

reinstateProxyInstance

public ReinstateProxyInstanceResponse reinstateProxyInstance(ReinstateProxyInstanceRequest request)

Description copied from interface: ShardedDatabaseService

API to reinstate the proxy instances associated with the private endpoint.

Specified by:

reinstateProxyInstance in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startShardedDatabase

public StartShardedDatabaseResponse startShardedDatabase(StartShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Start the shards, catalog and GSMs of Sharded Database.

Specified by:

startShardedDatabase in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopShardedDatabase

public StopShardedDatabaseResponse stopShardedDatabase(StopShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Stop the shards, catalog and GSM instances for the sharded database.

Specified by:

stopShardedDatabase in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePrivateEndpoint

public UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)

Description copied from interface: ShardedDatabaseService

Updates the configuration of privateendpoint.

Specified by:

updatePrivateEndpoint in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateShardedDatabase

public UpdateShardedDatabaseResponse updateShardedDatabase(UpdateShardedDatabaseRequest request)

Description copied from interface: ShardedDatabaseService

Updates the configuration of sharded database.

Specified by:

updateShardedDatabase in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

uploadSignedCertificateAndGenerateWallet

public UploadSignedCertificateAndGenerateWalletResponse uploadSignedCertificateAndGenerateWallet(UploadSignedCertificateAndGenerateWalletRequest request)

Description copied from interface: ShardedDatabaseService

Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the sharded database.

Customer shall provide the CA signed certificate key details by adding the certificate in request body.

Specified by:

uploadSignedCertificateAndGenerateWallet in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

validateNetwork

public ValidateNetworkResponse validateNetwork(ValidateNetworkRequest request)

Description copied from interface: ShardedDatabaseService

Validate the network connectivity between components of sharded database.

Specified by:

validateNetwork in interface ShardedDatabaseService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ShardedDatabaseServiceWaiters getWaiters()

Description copied from interface: ShardedDatabaseService

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface ShardedDatabaseService

Returns:

The service waiters.

getPaginators

public ShardedDatabaseServicePaginators getPaginators()

Description copied from interface: ShardedDatabaseService

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface ShardedDatabaseService

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

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

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()