Class OciCacheBackupClient

Service client instance for OciCacheBackup.

Inheritance

object

ClientBase

RegionalClientBase

OciCacheBackupClient

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)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.RedisService

Assembly: OCI.DotNetSDK.Redis.dll

Syntax

public class OciCacheBackupClient : RegionalClientBase, IDisposable

Constructors

OciCacheBackupClient(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 OciCacheBackupClient(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 OciCacheBackupPaginators Paginators { get; }

Property Value

Type	Description
OciCacheBackupPaginators

Waiters

Declaration

public OciCacheBackupWaiters Waiters { get; }

Property Value

Type	Description
OciCacheBackupWaiters

Methods

ChangeOciCacheBackupCompartment(ChangeOciCacheBackupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an OCI Cache Backup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeOciCacheBackupCompartmentResponse> ChangeOciCacheBackupCompartment(ChangeOciCacheBackupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateOciCacheBackup(CreateOciCacheBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new OCI Cache Backup.

Declaration

public Task<CreateOciCacheBackupResponse> CreateOciCacheBackup(CreateOciCacheBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteOciCacheBackup(DeleteOciCacheBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an OCI Cache Backup resource by identifier

Declaration

public Task<DeleteOciCacheBackupResponse> DeleteOciCacheBackup(DeleteOciCacheBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ExportOciCacheBackupToObjectStorage(ExportOciCacheBackupToObjectStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Initiates an asynchronous export of the backup\u2019s RDB file(s) to the specified Object Storage bucket. The service generates the object names. For sharded backups, one object is written per shard under the optional prefix.

Declaration

public Task<ExportOciCacheBackupToObjectStorageResponse> ExportOciCacheBackupToObjectStorage(ExportOciCacheBackupToObjectStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetOciCacheBackup(GetOciCacheBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an OCI Cache Backup by identifier

Declaration

public Task<GetOciCacheBackupResponse> GetOciCacheBackup(GetOciCacheBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListOciCacheBackups(ListOciCacheBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of OCI Cache Backups.

Declaration

public Task<ListOciCacheBackupsResponse> ListOciCacheBackups(ListOciCacheBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateOciCacheBackup(UpdateOciCacheBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the OCI Cache Backup

Declaration

public Task<UpdateOciCacheBackupResponse> UpdateOciCacheBackup(UpdateOciCacheBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable