Class DistributedDbServiceClient
Service client instance for DistributedDbService.
Implements
Inherited Members
Namespace: Oci.Distributeddatabasev26Service
Assembly: OCI.DotNetSDK.Distributeddatabasev26.dll
Syntax
public class DistributedDbServiceClient : RegionalClientBase, IDisposable
Constructors
DistributedDbServiceClient(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 DistributedDbServiceClient(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 DistributedDbServicePaginators Paginators { get; }
Property Value
| Type | Description |
|---|---|
| DistributedDbServicePaginators |
Waiters
Declaration
public DistributedDbServiceWaiters Waiters { get; }
Property Value
| Type | Description |
|---|---|
| DistributedDbServiceWaiters |
Methods
AddDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add new Global database services control(GDS CTL) node for the Globally distributed database.
Declaration
public Task<AddDistributedDatabaseGdsControlNodeResponse> AddDistributedDatabaseGdsControlNode(AddDistributedDatabaseGdsControlNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| AddDistributedDatabaseGdsControlNodeRequest | 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<AddDistributedDatabaseGdsControlNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddDistributedDatabaseGdsControlNode API.
ChangeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Move the Globally distributed database and its dependent resources to the specified compartment.
Declaration
public Task<ChangeDistributedDatabaseCompartmentResponse> ChangeDistributedDatabaseCompartment(ChangeDistributedDatabaseCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ChangeDistributedDatabaseCompartmentRequest | 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<ChangeDistributedDatabaseCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDistributedDatabaseCompartment API.
ChangeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Change the DbBackupConfig for the Globally distributed database.
Declaration
public Task<ChangeDistributedDbBackupConfigResponse> ChangeDistributedDbBackupConfig(ChangeDistributedDbBackupConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ChangeDistributedDbBackupConfigRequest | 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<ChangeDistributedDbBackupConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDistributedDbBackupConfig API.
ConfigureDistributedDatabaseAutoResourceManagement(ConfigureDistributedDatabaseAutoResourceManagementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Configure autoResourceManagement options for the Globally distributed database.
Declaration
public Task<ConfigureDistributedDatabaseAutoResourceManagementResponse> ConfigureDistributedDatabaseAutoResourceManagement(ConfigureDistributedDatabaseAutoResourceManagementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ConfigureDistributedDatabaseAutoResourceManagementRequest | 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<ConfigureDistributedDatabaseAutoResourceManagementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConfigureDistributedDatabaseAutoResourceManagement API.
ConfigureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.
Declaration
public Task<ConfigureDistributedDatabaseGsmsResponse> ConfigureDistributedDatabaseGsms(ConfigureDistributedDatabaseGsmsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ConfigureDistributedDatabaseGsmsRequest | 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<ConfigureDistributedDatabaseGsmsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConfigureDistributedDatabaseGsms API.
ConfigureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. 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.
Declaration
public Task<ConfigureDistributedDatabaseShardingResponse> ConfigureDistributedDatabaseSharding(ConfigureDistributedDatabaseShardingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ConfigureDistributedDatabaseShardingRequest | 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<ConfigureDistributedDatabaseShardingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConfigureDistributedDatabaseSharding API.
CreateDistributedDatabase(CreateDistributedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a Globally distributed database.
Declaration
public Task<CreateDistributedDatabaseResponse> CreateDistributedDatabase(CreateDistributedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateDistributedDatabaseRequest | 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<CreateDistributedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDistributedDatabase API.
DeleteDistributedDatabase(DeleteDistributedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Terminate the given Globally distributed database.
Declaration
public Task<DeleteDistributedDatabaseResponse> DeleteDistributedDatabase(DeleteDistributedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteDistributedDatabaseRequest | 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<DeleteDistributedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDistributedDatabase API.
GenerateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Generate the wallet associated with Globally distributed database.
Declaration
public Task<GenerateDistributedDatabaseWalletResponse> GenerateDistributedDatabaseWallet(GenerateDistributedDatabaseWalletRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateDistributedDatabaseWalletRequest | 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<GenerateDistributedDatabaseWalletResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GenerateDistributedDatabaseWallet API.
GetDistributedDatabase(GetDistributedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of the Globally distributed database identified by given id.
Declaration
public Task<GetDistributedDatabaseResponse> GetDistributedDatabase(GetDistributedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GetDistributedDatabaseRequest | 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<GetDistributedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDistributedDatabase API.
GetDistributedDatabaseRaftMetric(GetDistributedDatabaseRaftMetricRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Operation 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.
Declaration
public Task<GetDistributedDatabaseRaftMetricResponse> GetDistributedDatabaseRaftMetric(GetDistributedDatabaseRaftMetricRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GetDistributedDatabaseRaftMetricRequest | 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<GetDistributedDatabaseRaftMetricResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDistributedDatabaseRaftMetric API.
GetDistributedDatabaseRuChangeLog(GetDistributedDatabaseRuChangeLogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Operation to retrieve move RU invocation history and status for the Globally distributed database. Results are ordered by created timestamp in descending order.
Declaration
public Task<GetDistributedDatabaseRuChangeLogResponse> GetDistributedDatabaseRuChangeLog(GetDistributedDatabaseRuChangeLogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GetDistributedDatabaseRuChangeLogRequest | 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<GetDistributedDatabaseRuChangeLogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDistributedDatabaseRuChangeLog API.
ListDistributedDatabases(ListDistributedDatabasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List of Globally distributed databases.
Declaration
public Task<ListDistributedDatabasesResponse> ListDistributedDatabases(ListDistributedDatabasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ListDistributedDatabasesRequest | 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<ListDistributedDatabasesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDistributedDatabases API.
MoveDistributedDatabaseReplicationUnit(MoveDistributedDatabaseReplicationUnitRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Move the replication units for RAFT based globally distributed database from source shard to destination shard.
Declaration
public Task<MoveDistributedDatabaseReplicationUnitResponse> MoveDistributedDatabaseReplicationUnit(MoveDistributedDatabaseReplicationUnitRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| MoveDistributedDatabaseReplicationUnitRequest | 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<MoveDistributedDatabaseReplicationUnitResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use MoveDistributedDatabaseReplicationUnit API.
PatchDistributedDatabase(PatchDistributedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Patch 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.
Declaration
public Task<PatchDistributedDatabaseResponse> PatchDistributedDatabase(PatchDistributedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| PatchDistributedDatabaseRequest | 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<PatchDistributedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PatchDistributedDatabase API.
RecreateFailedDistributedDatabaseResource(RecreateFailedDistributedDatabaseResourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Recreate the failed resource for the Globally Distributed Database.
Declaration
public Task<RecreateFailedDistributedDatabaseResourceResponse> RecreateFailedDistributedDatabaseResource(RecreateFailedDistributedDatabaseResourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| RecreateFailedDistributedDatabaseResourceRequest | 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<RecreateFailedDistributedDatabaseResourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RecreateFailedDistributedDatabaseResource API.
RotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed database. This operation will also remove GdsCtlNodes if present.
Declaration
public Task<RotateDistributedDatabasePasswordsResponse> RotateDistributedDatabasePasswords(RotateDistributedDatabasePasswordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| RotateDistributedDatabasePasswordsRequest | 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<RotateDistributedDatabasePasswordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RotateDistributedDatabasePasswords API.
ScaleDistributedDatabaseGsms(ScaleDistributedDatabaseGsmsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Scale global service manager(GSM aka shard manager) instances for the Globally distributed database.
Declaration
public Task<ScaleDistributedDatabaseGsmsResponse> ScaleDistributedDatabaseGsms(ScaleDistributedDatabaseGsmsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ScaleDistributedDatabaseGsmsRequest | 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<ScaleDistributedDatabaseGsmsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ScaleDistributedDatabaseGsms API.
StartDistributedDatabase(StartDistributedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Start the shards, catalog, GSMs and GDSCTL instances of Globally distributed database.
Declaration
public Task<StartDistributedDatabaseResponse> StartDistributedDatabase(StartDistributedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| StartDistributedDatabaseRequest | 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<StartDistributedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StartDistributedDatabase API.
StopDistributedDatabase(StopDistributedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Stop the shards, catalog, GSMs and GDSCTL instances for the Globally distributed database.
Declaration
public Task<StopDistributedDatabaseResponse> StopDistributedDatabase(StopDistributedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| StopDistributedDatabaseRequest | 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<StopDistributedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StopDistributedDatabase API.
UpdateDistributedDatabase(UpdateDistributedDatabaseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the configuration of the Globally distributed database.
Declaration
public Task<UpdateDistributedDatabaseResponse> UpdateDistributedDatabase(UpdateDistributedDatabaseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateDistributedDatabaseRequest | 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<UpdateDistributedDatabaseResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDistributedDatabase API.
ValidateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validate the network connectivity between components of the globally distributed database.
Declaration
public Task<ValidateDistributedDatabaseNetworkResponse> ValidateDistributedDatabaseNetwork(ValidateDistributedDatabaseNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ValidateDistributedDatabaseNetworkRequest | 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<ValidateDistributedDatabaseNetworkResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateDistributedDatabaseNetwork API.