Class ReplicasClient
Service client instance for Replicas.
Implements
Inherited Members
Namespace: Oci.MysqlService
Assembly: OCI.DotNetSDK.Mysql.dll
Syntax
public class ReplicasClient : RegionalClientBase, IDisposable
Constructors
ReplicasClient(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 ReplicasClient(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 ReplicasPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ReplicasPaginators |
Waiters
Declaration
public ReplicasWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
ReplicasWaiters |
Methods
CreateReplica(CreateReplicaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a DB System read replica.
Declaration
public Task<CreateReplicaResponse> CreateReplica(CreateReplicaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateReplicaRequest | 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<CreateReplicaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateReplica API.
DeleteReplica(DeleteReplicaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified read replica.
Declaration
public Task<DeleteReplicaResponse> DeleteReplica(DeleteReplicaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteReplicaRequest | 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<DeleteReplicaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteReplica API.
GetReplica(GetReplicaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the full details of the specified read replica.
Declaration
public Task<GetReplicaResponse> GetReplica(GetReplicaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetReplicaRequest | 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<GetReplicaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetReplica API.
ListReplicas(ListReplicasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all the read replicas that match the specified filters.
Declaration
public Task<ListReplicasResponse> ListReplicas(ListReplicasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListReplicasRequest | 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<ListReplicasResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListReplicas API.
UpdateReplica(UpdateReplicaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the properties of the specified read replica.
Declaration
public Task<UpdateReplicaResponse> UpdateReplica(UpdateReplicaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateReplicaRequest | 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<UpdateReplicaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateReplica API.