Class OpensearchClusterBackupClient

Service client instance for OpensearchClusterBackup.

Inheritance

object

ClientBase

RegionalClientBase

OpensearchClusterBackupClient

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.OpensearchService

Assembly: OCI.DotNetSDK.Opensearch.dll

Syntax

public class OpensearchClusterBackupClient : RegionalClientBase, IDisposable

Constructors

OpensearchClusterBackupClient(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 OpensearchClusterBackupClient(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 OpensearchClusterBackupPaginators Paginators { get; }

Property Value

Type	Description
OpensearchClusterBackupPaginators

Waiters

Declaration

public OpensearchClusterBackupWaiters Waiters { get; }

Property Value

Type	Description
OpensearchClusterBackupWaiters

Methods

DeleteOpensearchClusterBackup(DeleteOpensearchClusterBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a OpensearchClusterBackup resource by identifier

Declaration

public Task<DeleteOpensearchClusterBackupResponse> DeleteOpensearchClusterBackup(DeleteOpensearchClusterBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetOpensearchClusterBackup(GetOpensearchClusterBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a OpensearchClusterBackup by identifier

Declaration

public Task<GetOpensearchClusterBackupResponse> GetOpensearchClusterBackup(GetOpensearchClusterBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListOpensearchClusterBackups(ListOpensearchClusterBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of OpensearchClusterBackups.

Declaration

public Task<ListOpensearchClusterBackupsResponse> ListOpensearchClusterBackups(ListOpensearchClusterBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateOpensearchClusterBackup(UpdateOpensearchClusterBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the OpensearchClusterBackup

Declaration

public Task<UpdateOpensearchClusterBackupResponse> UpdateOpensearchClusterBackup(UpdateOpensearchClusterBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable