Class DbBackupsClient

Service client instance for DbBackups.

Inheritance

object

ClientBase

RegionalClientBase

DbBackupsClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MysqlService

Assembly: OCI.DotNetSDK.Mysql.dll

Syntax

public class DbBackupsClient : RegionalClientBase, IDisposable

Constructors

DbBackupsClient(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 DbBackupsClient(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 DbBackupsPaginators Paginators { get; }

Property Value

Type	Description
DbBackupsPaginators

Waiters

Declaration

public DbBackupsWaiters Waiters { get; }

Property Value

Type	Description
DbBackupsWaiters

Methods

CancelBackupDeletion(CancelBackupDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the scheduled deletion of a backup and moves it to ACTIVE state.

Declaration

public Task<CancelBackupDeletionResponse> CancelBackupDeletion(CancelBackupDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelBackupDeletionRequest	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<CancelBackupDeletionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelBackupDeletion API.

ChangeBackupCompartment(ChangeBackupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a DB System Backup into a different compartment. When provided, If-Match is checked against ETag values of the Backup.

Declaration

public Task<ChangeBackupCompartmentResponse> ChangeBackupCompartment(ChangeBackupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeBackupCompartmentRequest	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<ChangeBackupCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeBackupCompartment API.

CopyBackup(CopyBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a copy of a DB system backup available in the specified source region.

Declaration

public Task<CopyBackupResponse> CopyBackup(CopyBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CopyBackupRequest	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<CopyBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CopyBackup API.

CreateBackup(CreateBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a backup of a DB System.

Declaration

public Task<CreateBackupResponse> CreateBackup(CreateBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateBackupRequest	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<CreateBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateBackup API.

DeleteBackup(DeleteBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Backup.

Declaration

public Task<DeleteBackupResponse> DeleteBackup(DeleteBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteBackupRequest	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<DeleteBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteBackup API.

GetBackup(GetBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get information about the specified Backup

Declaration

public Task<GetBackupResponse> GetBackup(GetBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetBackupRequest	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<GetBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetBackup API.

ListBackups(ListBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a list of DB System backups.

Declaration

public Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListBackupsRequest	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<ListBackupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListBackups API.

UpdateBackup(UpdateBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the metadata of a Backup. Metadata such as the displayName or description

Declaration

public Task<UpdateBackupResponse> UpdateBackup(UpdateBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateBackupRequest	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<UpdateBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateBackup API.

Implements

IDisposable