Interface ISnapshotNamespace

Snapshot APIs.

Use the Snapshot property on IOpenSearchClient.

Namespace: OpenSearch.Client.Specification.SnapshotApi
Assembly: OpenSearch.Client.dll
Syntax
public interface ISnapshotNamespace

Methods

| Edit this page View Source

CleanupRepository(ICleanupRepositoryRequest)

POST request to the snapshot.cleanup_repository API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
CleanupRepositoryResponse CleanupRepository(ICleanupRepositoryRequest request)
Parameters
Type Name Description
ICleanupRepositoryRequest request
Returns
Type Description
CleanupRepositoryResponse
| Edit this page View Source

CleanupRepository(Name, Func<CleanupRepositoryDescriptor, ICleanupRepositoryRequest>)

POST request to the snapshot.cleanup_repository API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
CleanupRepositoryResponse CleanupRepository(Name repository, Func<CleanupRepositoryDescriptor, ICleanupRepositoryRequest> selector = null)
Parameters
Type Name Description
Name repository
Func<CleanupRepositoryDescriptor, ICleanupRepositoryRequest> selector
Returns
Type Description
CleanupRepositoryResponse
| Edit this page View Source

CleanupRepositoryAsync(ICleanupRepositoryRequest, CancellationToken)

POST request to the snapshot.cleanup_repository API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<CleanupRepositoryResponse> CleanupRepositoryAsync(ICleanupRepositoryRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ICleanupRepositoryRequest request
CancellationToken ct
Returns
Type Description
Task<CleanupRepositoryResponse>
| Edit this page View Source

CleanupRepositoryAsync(Name, Func<CleanupRepositoryDescriptor, ICleanupRepositoryRequest>, CancellationToken)

POST request to the snapshot.cleanup_repository API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<CleanupRepositoryResponse> CleanupRepositoryAsync(Name repository, Func<CleanupRepositoryDescriptor, ICleanupRepositoryRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Func<CleanupRepositoryDescriptor, ICleanupRepositoryRequest> selector
CancellationToken ct
Returns
Type Description
Task<CleanupRepositoryResponse>
| Edit this page View Source

Clone(ICloneSnapshotRequest)

PUT request to the snapshot.clone API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
CloneSnapshotResponse Clone(ICloneSnapshotRequest request)
Parameters
Type Name Description
ICloneSnapshotRequest request
Returns
Type Description
CloneSnapshotResponse
| Edit this page View Source

Clone(Name, Name, Name, Func<CloneSnapshotDescriptor, ICloneSnapshotRequest>)

PUT request to the snapshot.clone API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
CloneSnapshotResponse Clone(Name repository, Name snapshot, Name targetSnapshot, Func<CloneSnapshotDescriptor, ICloneSnapshotRequest> selector)
Parameters
Type Name Description
Name repository
Name snapshot
Name targetSnapshot
Func<CloneSnapshotDescriptor, ICloneSnapshotRequest> selector
Returns
Type Description
CloneSnapshotResponse
| Edit this page View Source

CloneAsync(ICloneSnapshotRequest, CancellationToken)

PUT request to the snapshot.clone API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<CloneSnapshotResponse> CloneAsync(ICloneSnapshotRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ICloneSnapshotRequest request
CancellationToken ct
Returns
Type Description
Task<CloneSnapshotResponse>
| Edit this page View Source

CloneAsync(Name, Name, Name, Func<CloneSnapshotDescriptor, ICloneSnapshotRequest>, CancellationToken)

PUT request to the snapshot.clone API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<CloneSnapshotResponse> CloneAsync(Name repository, Name snapshot, Name targetSnapshot, Func<CloneSnapshotDescriptor, ICloneSnapshotRequest> selector, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Name snapshot
Name targetSnapshot
Func<CloneSnapshotDescriptor, ICloneSnapshotRequest> selector
CancellationToken ct
Returns
Type Description
Task<CloneSnapshotResponse>
| Edit this page View Source

CreateRepository(ICreateRepositoryRequest)

PUT request to the snapshot.create_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/
Declaration
CreateRepositoryResponse CreateRepository(ICreateRepositoryRequest request)
Parameters
Type Name Description
ICreateRepositoryRequest request
Returns
Type Description
CreateRepositoryResponse
| Edit this page View Source

CreateRepository(Name, Func<CreateRepositoryDescriptor, ICreateRepositoryRequest>)

PUT request to the snapshot.create_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/
Declaration
CreateRepositoryResponse CreateRepository(Name repository, Func<CreateRepositoryDescriptor, ICreateRepositoryRequest> selector)
Parameters
Type Name Description
Name repository
Func<CreateRepositoryDescriptor, ICreateRepositoryRequest> selector
Returns
Type Description
CreateRepositoryResponse
| Edit this page View Source

CreateRepositoryAsync(ICreateRepositoryRequest, CancellationToken)

PUT request to the snapshot.create_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/
Declaration
Task<CreateRepositoryResponse> CreateRepositoryAsync(ICreateRepositoryRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ICreateRepositoryRequest request
CancellationToken ct
Returns
Type Description
Task<CreateRepositoryResponse>
| Edit this page View Source

CreateRepositoryAsync(Name, Func<CreateRepositoryDescriptor, ICreateRepositoryRequest>, CancellationToken)

PUT request to the snapshot.create_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/
Declaration
Task<CreateRepositoryResponse> CreateRepositoryAsync(Name repository, Func<CreateRepositoryDescriptor, ICreateRepositoryRequest> selector, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Func<CreateRepositoryDescriptor, ICreateRepositoryRequest> selector
CancellationToken ct
Returns
Type Description
Task<CreateRepositoryResponse>
| Edit this page View Source

Delete(IDeleteSnapshotRequest)

DELETE request to the snapshot.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/
Declaration
DeleteSnapshotResponse Delete(IDeleteSnapshotRequest request)
Parameters
Type Name Description
IDeleteSnapshotRequest request
Returns
Type Description
DeleteSnapshotResponse
| Edit this page View Source

Delete(Name, Name, Func<DeleteSnapshotDescriptor, IDeleteSnapshotRequest>)

DELETE request to the snapshot.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/
Declaration
DeleteSnapshotResponse Delete(Name repository, Name snapshot, Func<DeleteSnapshotDescriptor, IDeleteSnapshotRequest> selector = null)
Parameters
Type Name Description
Name repository
Name snapshot
Func<DeleteSnapshotDescriptor, IDeleteSnapshotRequest> selector
Returns
Type Description
DeleteSnapshotResponse
| Edit this page View Source

DeleteAsync(IDeleteSnapshotRequest, CancellationToken)

DELETE request to the snapshot.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/
Declaration
Task<DeleteSnapshotResponse> DeleteAsync(IDeleteSnapshotRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IDeleteSnapshotRequest request
CancellationToken ct
Returns
Type Description
Task<DeleteSnapshotResponse>
| Edit this page View Source

DeleteAsync(Name, Name, Func<DeleteSnapshotDescriptor, IDeleteSnapshotRequest>, CancellationToken)

DELETE request to the snapshot.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/
Declaration
Task<DeleteSnapshotResponse> DeleteAsync(Name repository, Name snapshot, Func<DeleteSnapshotDescriptor, IDeleteSnapshotRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Name snapshot
Func<DeleteSnapshotDescriptor, IDeleteSnapshotRequest> selector
CancellationToken ct
Returns
Type Description
Task<DeleteSnapshotResponse>
| Edit this page View Source

DeleteRepository(IDeleteRepositoryRequest)

DELETE request to the snapshot.delete_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/
Declaration
DeleteRepositoryResponse DeleteRepository(IDeleteRepositoryRequest request)
Parameters
Type Name Description
IDeleteRepositoryRequest request
Returns
Type Description
DeleteRepositoryResponse
| Edit this page View Source

DeleteRepository(Names, Func<DeleteRepositoryDescriptor, IDeleteRepositoryRequest>)

DELETE request to the snapshot.delete_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/
Declaration
DeleteRepositoryResponse DeleteRepository(Names repository, Func<DeleteRepositoryDescriptor, IDeleteRepositoryRequest> selector = null)
Parameters
Type Name Description
Names repository
Func<DeleteRepositoryDescriptor, IDeleteRepositoryRequest> selector
Returns
Type Description
DeleteRepositoryResponse
| Edit this page View Source

DeleteRepositoryAsync(IDeleteRepositoryRequest, CancellationToken)

DELETE request to the snapshot.delete_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/
Declaration
Task<DeleteRepositoryResponse> DeleteRepositoryAsync(IDeleteRepositoryRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IDeleteRepositoryRequest request
CancellationToken ct
Returns
Type Description
Task<DeleteRepositoryResponse>
| Edit this page View Source

DeleteRepositoryAsync(Names, Func<DeleteRepositoryDescriptor, IDeleteRepositoryRequest>, CancellationToken)

DELETE request to the snapshot.delete_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/
Declaration
Task<DeleteRepositoryResponse> DeleteRepositoryAsync(Names repository, Func<DeleteRepositoryDescriptor, IDeleteRepositoryRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Names repository
Func<DeleteRepositoryDescriptor, IDeleteRepositoryRequest> selector
CancellationToken ct
Returns
Type Description
Task<DeleteRepositoryResponse>
| Edit this page View Source

Get(IGetSnapshotRequest)

GET request to the snapshot.get API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
GetSnapshotResponse Get(IGetSnapshotRequest request)
Parameters
Type Name Description
IGetSnapshotRequest request
Returns
Type Description
GetSnapshotResponse
| Edit this page View Source

Get(Name, Names, Func<GetSnapshotDescriptor, IGetSnapshotRequest>)

GET request to the snapshot.get API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
GetSnapshotResponse Get(Name repository, Names snapshot, Func<GetSnapshotDescriptor, IGetSnapshotRequest> selector = null)
Parameters
Type Name Description
Name repository
Names snapshot
Func<GetSnapshotDescriptor, IGetSnapshotRequest> selector
Returns
Type Description
GetSnapshotResponse
| Edit this page View Source

GetAsync(IGetSnapshotRequest, CancellationToken)

GET request to the snapshot.get API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<GetSnapshotResponse> GetAsync(IGetSnapshotRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetSnapshotRequest request
CancellationToken ct
Returns
Type Description
Task<GetSnapshotResponse>
| Edit this page View Source

GetAsync(Name, Names, Func<GetSnapshotDescriptor, IGetSnapshotRequest>, CancellationToken)

GET request to the snapshot.get API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<GetSnapshotResponse> GetAsync(Name repository, Names snapshot, Func<GetSnapshotDescriptor, IGetSnapshotRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Names snapshot
Func<GetSnapshotDescriptor, IGetSnapshotRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetSnapshotResponse>
| Edit this page View Source

GetRepository(IGetRepositoryRequest)

GET request to the snapshot.get_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/
Declaration
GetRepositoryResponse GetRepository(IGetRepositoryRequest request)
Parameters
Type Name Description
IGetRepositoryRequest request
Returns
Type Description
GetRepositoryResponse
| Edit this page View Source

GetRepository(Func<GetRepositoryDescriptor, IGetRepositoryRequest>)

GET request to the snapshot.get_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/
Declaration
GetRepositoryResponse GetRepository(Func<GetRepositoryDescriptor, IGetRepositoryRequest> selector = null)
Parameters
Type Name Description
Func<GetRepositoryDescriptor, IGetRepositoryRequest> selector
Returns
Type Description
GetRepositoryResponse
| Edit this page View Source

GetRepositoryAsync(IGetRepositoryRequest, CancellationToken)

GET request to the snapshot.get_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/
Declaration
Task<GetRepositoryResponse> GetRepositoryAsync(IGetRepositoryRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetRepositoryRequest request
CancellationToken ct
Returns
Type Description
Task<GetRepositoryResponse>
| Edit this page View Source

GetRepositoryAsync(Func<GetRepositoryDescriptor, IGetRepositoryRequest>, CancellationToken)

GET request to the snapshot.get_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/
Declaration
Task<GetRepositoryResponse> GetRepositoryAsync(Func<GetRepositoryDescriptor, IGetRepositoryRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<GetRepositoryDescriptor, IGetRepositoryRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetRepositoryResponse>
| Edit this page View Source

Restore(IRestoreRequest)

POST request to the snapshot.restore API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/
Declaration
RestoreResponse Restore(IRestoreRequest request)
Parameters
Type Name Description
IRestoreRequest request
Returns
Type Description
RestoreResponse
| Edit this page View Source

Restore(Name, Name, Func<RestoreDescriptor, IRestoreRequest>)

POST request to the snapshot.restore API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/
Declaration
RestoreResponse Restore(Name repository, Name snapshot, Func<RestoreDescriptor, IRestoreRequest> selector = null)
Parameters
Type Name Description
Name repository
Name snapshot
Func<RestoreDescriptor, IRestoreRequest> selector
Returns
Type Description
RestoreResponse
| Edit this page View Source

RestoreAsync(IRestoreRequest, CancellationToken)

POST request to the snapshot.restore API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/
Declaration
Task<RestoreResponse> RestoreAsync(IRestoreRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IRestoreRequest request
CancellationToken ct
Returns
Type Description
Task<RestoreResponse>
| Edit this page View Source

RestoreAsync(Name, Name, Func<RestoreDescriptor, IRestoreRequest>, CancellationToken)

POST request to the snapshot.restore API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/
Declaration
Task<RestoreResponse> RestoreAsync(Name repository, Name snapshot, Func<RestoreDescriptor, IRestoreRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Name snapshot
Func<RestoreDescriptor, IRestoreRequest> selector
CancellationToken ct
Returns
Type Description
Task<RestoreResponse>
| Edit this page View Source

Snapshot(ISnapshotRequest)

PUT request to the snapshot.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/
Declaration
SnapshotResponse Snapshot(ISnapshotRequest request)
Parameters
Type Name Description
ISnapshotRequest request
Returns
Type Description
SnapshotResponse
| Edit this page View Source

Snapshot(Name, Name, Func<SnapshotDescriptor, ISnapshotRequest>)

PUT request to the snapshot.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/
Declaration
SnapshotResponse Snapshot(Name repository, Name snapshot, Func<SnapshotDescriptor, ISnapshotRequest> selector = null)
Parameters
Type Name Description
Name repository
Name snapshot
Func<SnapshotDescriptor, ISnapshotRequest> selector
Returns
Type Description
SnapshotResponse
| Edit this page View Source

SnapshotAsync(ISnapshotRequest, CancellationToken)

PUT request to the snapshot.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/
Declaration
Task<SnapshotResponse> SnapshotAsync(ISnapshotRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ISnapshotRequest request
CancellationToken ct
Returns
Type Description
Task<SnapshotResponse>
| Edit this page View Source

SnapshotAsync(Name, Name, Func<SnapshotDescriptor, ISnapshotRequest>, CancellationToken)

PUT request to the snapshot.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/
Declaration
Task<SnapshotResponse> SnapshotAsync(Name repository, Name snapshot, Func<SnapshotDescriptor, ISnapshotRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Name snapshot
Func<SnapshotDescriptor, ISnapshotRequest> selector
CancellationToken ct
Returns
Type Description
Task<SnapshotResponse>
| Edit this page View Source

Status(ISnapshotStatusRequest)

GET request to the snapshot.status API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/
Declaration
SnapshotStatusResponse Status(ISnapshotStatusRequest request)
Parameters
Type Name Description
ISnapshotStatusRequest request
Returns
Type Description
SnapshotStatusResponse
| Edit this page View Source

Status(Func<SnapshotStatusDescriptor, ISnapshotStatusRequest>)

GET request to the snapshot.status API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/
Declaration
SnapshotStatusResponse Status(Func<SnapshotStatusDescriptor, ISnapshotStatusRequest> selector = null)
Parameters
Type Name Description
Func<SnapshotStatusDescriptor, ISnapshotStatusRequest> selector
Returns
Type Description
SnapshotStatusResponse
| Edit this page View Source

StatusAsync(ISnapshotStatusRequest, CancellationToken)

GET request to the snapshot.status API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/
Declaration
Task<SnapshotStatusResponse> StatusAsync(ISnapshotStatusRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ISnapshotStatusRequest request
CancellationToken ct
Returns
Type Description
Task<SnapshotStatusResponse>
| Edit this page View Source

StatusAsync(Func<SnapshotStatusDescriptor, ISnapshotStatusRequest>, CancellationToken)

GET request to the snapshot.status API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/
Declaration
Task<SnapshotStatusResponse> StatusAsync(Func<SnapshotStatusDescriptor, ISnapshotStatusRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<SnapshotStatusDescriptor, ISnapshotStatusRequest> selector
CancellationToken ct
Returns
Type Description
Task<SnapshotStatusResponse>
| Edit this page View Source

VerifyRepository(IVerifyRepositoryRequest)

POST request to the snapshot.verify_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/
Declaration
VerifyRepositoryResponse VerifyRepository(IVerifyRepositoryRequest request)
Parameters
Type Name Description
IVerifyRepositoryRequest request
Returns
Type Description
VerifyRepositoryResponse
| Edit this page View Source

VerifyRepository(Name, Func<VerifyRepositoryDescriptor, IVerifyRepositoryRequest>)

POST request to the snapshot.verify_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/
Declaration
VerifyRepositoryResponse VerifyRepository(Name repository, Func<VerifyRepositoryDescriptor, IVerifyRepositoryRequest> selector = null)
Parameters
Type Name Description
Name repository
Func<VerifyRepositoryDescriptor, IVerifyRepositoryRequest> selector
Returns
Type Description
VerifyRepositoryResponse
| Edit this page View Source

VerifyRepositoryAsync(IVerifyRepositoryRequest, CancellationToken)

POST request to the snapshot.verify_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/
Declaration
Task<VerifyRepositoryResponse> VerifyRepositoryAsync(IVerifyRepositoryRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IVerifyRepositoryRequest request
CancellationToken ct
Returns
Type Description
Task<VerifyRepositoryResponse>
| Edit this page View Source

VerifyRepositoryAsync(Name, Func<VerifyRepositoryDescriptor, IVerifyRepositoryRequest>, CancellationToken)

POST request to the snapshot.verify_repository API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/
Declaration
Task<VerifyRepositoryResponse> VerifyRepositoryAsync(Name repository, Func<VerifyRepositoryDescriptor, IVerifyRepositoryRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name repository
Func<VerifyRepositoryDescriptor, IVerifyRepositoryRequest> selector
CancellationToken ct
Returns
Type Description
Task<VerifyRepositoryResponse>

Extension Methods