Class ShardedDatabaseServiceClient
Service client instance for ShardedDatabaseService.
Implements
Inherited Members
Namespace: Oci.GloballydistributeddatabaseService
Assembly: OCI.DotNetSDK.Globallydistributeddatabase.dll
Syntax
public class ShardedDatabaseServiceClient : RegionalClientBase, IDisposable
Constructors
ShardedDatabaseServiceClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public ShardedDatabaseServiceClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public ShardedDatabaseServicePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ShardedDatabaseServicePaginators |
Waiters
Declaration
public ShardedDatabaseServiceWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
ShardedDatabaseServiceWaiters |
Methods
ChangePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Move the private endpoint to the specified compartment.
Declaration
public Task<ChangePrivateEndpointCompartmentResponse> ChangePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePrivateEndpointCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangePrivateEndpointCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePrivateEndpointCompartment API.
ChangeShardedDatabaseCompartment(ChangeShardedDatabaseCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Move the sharded database database and its dependent resources to the specified compartment.
Declaration
public Task<ChangeShardedDatabaseCompartmentResponse> ChangeShardedDatabaseCompartment(ChangeShardedDatabaseCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeShardedDatabaseCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeShardedDatabaseCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeShardedDatabaseCompartment API.
ConfigureShardedDatabaseGsms(ConfigureShardedDatabaseGsmsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ConfigureShardedDatabaseGsmsResponse> ConfigureShardedDatabaseGsms(ConfigureShardedDatabaseGsmsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ConfigureShardedDatabaseGsmsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ConfigureShardedDatabaseGsmsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConfigureShardedDatabaseGsms API.
ConfigureSharding(ConfigureShardingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ConfigureShardingResponse> ConfigureSharding(ConfigureShardingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ConfigureShardingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ConfigureShardingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConfigureSharding API.
CreatePrivateEndpoint(CreatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a PrivateEndpoint.
Declaration
public Task<CreatePrivateEndpointResponse> CreatePrivateEndpoint(CreatePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePrivateEndpoint API.
CreateShardedDatabase(CreateShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a Sharded Database.
Declaration
public Task<CreateShardedDatabaseResponse> CreateShardedDatabase(CreateShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateShardedDatabase API.
DeletePrivateEndpoint(DeletePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the given private endpoint.
Declaration
public Task<DeletePrivateEndpointResponse> DeletePrivateEndpoint(DeletePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePrivateEndpoint API.
DeleteShardedDatabase(DeleteShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Terminate the given sharded databases.
Declaration
public Task<DeleteShardedDatabaseResponse> DeleteShardedDatabase(DeleteShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteShardedDatabase API.
DownloadGsmCertificateSigningRequest(DownloadGsmCertificateSigningRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Generate the common certificate signing request for GSMs. Download the <sdb-prefix>.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.
Declaration
public Task<DownloadGsmCertificateSigningRequestResponse> DownloadGsmCertificateSigningRequest(DownloadGsmCertificateSigningRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DownloadGsmCertificateSigningRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DownloadGsmCertificateSigningRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DownloadGsmCertificateSigningRequest API.
FetchConnectionString(FetchConnectionStringRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the Sharded Database Connection Strings.
Declaration
public Task<FetchConnectionStringResponse> FetchConnectionString(FetchConnectionStringRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
FetchConnectionStringRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<FetchConnectionStringResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use FetchConnectionString API.
FetchShardableCloudAutonomousVmClusters(FetchShardableCloudAutonomousVmClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List of cloudAutonomousVMClusters for the given tenancy, that can be sharded.
Declaration
public Task<FetchShardableCloudAutonomousVmClustersResponse> FetchShardableCloudAutonomousVmClusters(FetchShardableCloudAutonomousVmClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
FetchShardableCloudAutonomousVmClustersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<FetchShardableCloudAutonomousVmClustersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use FetchShardableCloudAutonomousVmClusters API.
GenerateGsmCertificateSigningRequest(GenerateGsmCertificateSigningRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<GenerateGsmCertificateSigningRequestResponse> GenerateGsmCertificateSigningRequest(GenerateGsmCertificateSigningRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GenerateGsmCertificateSigningRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GenerateGsmCertificateSigningRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GenerateGsmCertificateSigningRequest API.
GenerateWallet(GenerateWalletRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Generate the wallet associated with sharded database.
Declaration
public Task<GenerateWalletResponse> GenerateWallet(GenerateWalletRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GenerateWalletRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GenerateWalletResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GenerateWallet API.
GetPrivateEndpoint(GetPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the PrivateEndpoint resource.
Declaration
public Task<GetPrivateEndpointResponse> GetPrivateEndpoint(GetPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPrivateEndpoint API.
GetShardedDatabase(GetShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of the Sharded database identified by given id.
Declaration
public Task<GetShardedDatabaseResponse> GetShardedDatabase(GetShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetShardedDatabase API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets details of the work request with the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListPrivateEndpoints(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List of PrivateEndpoints.
Declaration
public Task<ListPrivateEndpointsResponse> ListPrivateEndpoints(ListPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPrivateEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPrivateEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPrivateEndpoints API.
ListShardedDatabases(ListShardedDatabasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List of Sharded databases.
Declaration
public Task<ListShardedDatabasesResponse> ListShardedDatabases(ListShardedDatabasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListShardedDatabasesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListShardedDatabasesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListShardedDatabases API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of errors for the work request with the given ID.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of logs for the work request with the given ID.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
PatchShardedDatabase(PatchShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<PatchShardedDatabaseResponse> PatchShardedDatabase(PatchShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PatchShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PatchShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PatchShardedDatabase API.
PrevalidateShardedDatabase(PrevalidateShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Sharded database pre-validation request.
Declaration
public Task<PrevalidateShardedDatabaseResponse> PrevalidateShardedDatabase(PrevalidateShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PrevalidateShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PrevalidateShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PrevalidateShardedDatabase API.
ReinstateProxyInstance(ReinstateProxyInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
API to reinstate the proxy instances associated with the private endpoint.
Declaration
public Task<ReinstateProxyInstanceResponse> ReinstateProxyInstance(ReinstateProxyInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ReinstateProxyInstanceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ReinstateProxyInstanceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ReinstateProxyInstance API.
StartShardedDatabase(StartShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Start the shards, catalog and GSMs of Sharded Database.
Declaration
public Task<StartShardedDatabaseResponse> StartShardedDatabase(StartShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StartShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StartShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StartShardedDatabase API.
StopShardedDatabase(StopShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Stop the shards, catalog and GSM instances for the sharded database.
Declaration
public Task<StopShardedDatabaseResponse> StopShardedDatabase(StopShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StopShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StopShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StopShardedDatabase API.
UpdatePrivateEndpoint(UpdatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the configuration of privateendpoint.
Declaration
public Task<UpdatePrivateEndpointResponse> UpdatePrivateEndpoint(UpdatePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePrivateEndpoint API.
UpdateShardedDatabase(UpdateShardedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the configuration of sharded database.
Declaration
public Task<UpdateShardedDatabaseResponse> UpdateShardedDatabase(UpdateShardedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateShardedDatabaseRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateShardedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateShardedDatabase API.
UploadSignedCertificateAndGenerateWallet(UploadSignedCertificateAndGenerateWalletRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<UploadSignedCertificateAndGenerateWalletResponse> UploadSignedCertificateAndGenerateWallet(UploadSignedCertificateAndGenerateWalletRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UploadSignedCertificateAndGenerateWalletRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UploadSignedCertificateAndGenerateWalletResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UploadSignedCertificateAndGenerateWallet API.
ValidateNetwork(ValidateNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validate the network connectivity between components of sharded database.
Declaration
public Task<ValidateNetworkResponse> ValidateNetwork(ValidateNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateNetworkRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateNetworkResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateNetwork API.