Class LowLevelSnapshotNamespace

Snapshot APIs.

Not intended to be instantiated directly. Use the Snapshot property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelSnapshotNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.SnapshotApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelSnapshotNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

CleanupRepositoryAsync<TResponse>(string, CleanupRepositoryRequestParameters, CancellationToken)

POST on /_snapshot/{repository}/_cleanup

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> CleanupRepositoryAsync<TResponse>(string repository, CleanupRepositoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	Snapshot repository to clean up.
CleanupRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CleanupRepository<TResponse>(string, CleanupRepositoryRequestParameters)

POST on /_snapshot/{repository}/_cleanup

https://opensearch.org/docs/latest

Declaration

public TResponse CleanupRepository<TResponse>(string repository, CleanupRepositoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	Snapshot repository to clean up.
CleanupRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CloneAsync<TResponse>(string, string, string, PostData, CloneSnapshotRequestParameters, CancellationToken)

PUT on /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> CloneAsync<TResponse>(string repository, string snapshot, string targetSnapshot, PostData body, CloneSnapshotRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of repository which will contain the snapshots clone.
string	snapshot	The name of the original snapshot.
string	targetSnapshot	The name of the cloned snapshot.
PostData	body	The snapshot clone definition.
CloneSnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Clone<TResponse>(string, string, string, PostData, CloneSnapshotRequestParameters)

PUT on /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}

https://opensearch.org/docs/latest

Declaration

public TResponse Clone<TResponse>(string repository, string snapshot, string targetSnapshot, PostData body, CloneSnapshotRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of repository which will contain the snapshots clone.
string	snapshot	The name of the original snapshot.
string	targetSnapshot	The name of the cloned snapshot.
PostData	body	The snapshot clone definition.
CloneSnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateRepositoryAsync<TResponse>(string, PostData, CreateRepositoryRequestParameters, CancellationToken)

PUT on /_snapshot/{repository}

https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/

Declaration

public Task<TResponse> CreateRepositoryAsync<TResponse>(string repository, PostData body, CreateRepositoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name for the newly registered repository.
PostData	body	The repository definition.
CreateRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateRepository<TResponse>(string, PostData, CreateRepositoryRequestParameters)

PUT on /_snapshot/{repository}

https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/

Declaration

public TResponse CreateRepository<TResponse>(string repository, PostData body, CreateRepositoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name for the newly registered repository.
PostData	body	The repository definition.
CreateRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteAsync<TResponse>(string, string, DeleteSnapshotRequestParameters, CancellationToken)

DELETE on /_snapshot/{repository}/{snapshot}

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/

Declaration

public Task<TResponse> DeleteAsync<TResponse>(string repository, string snapshot, DeleteSnapshotRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the snapshot repository to delete.
string	snapshot	A comma-separated list of snapshot names to delete from the repository.
DeleteSnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteRepositoryAsync<TResponse>(string, DeleteRepositoryRequestParameters, CancellationToken)

DELETE on /_snapshot/{repository}

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/

Declaration

public Task<TResponse> DeleteRepositoryAsync<TResponse>(string repository, DeleteRepositoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the snapshot repository to unregister. Wildcard (<c>*</c>) patterns are supported.
DeleteRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteRepository<TResponse>(string, DeleteRepositoryRequestParameters)

DELETE on /_snapshot/{repository}

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/

Declaration

public TResponse DeleteRepository<TResponse>(string repository, DeleteRepositoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the snapshot repository to unregister. Wildcard (<c>*</c>) patterns are supported.
DeleteRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Delete<TResponse>(string, string, DeleteSnapshotRequestParameters)

DELETE on /_snapshot/{repository}/{snapshot}

https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/

Declaration

public TResponse Delete<TResponse>(string repository, string snapshot, DeleteSnapshotRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the snapshot repository to delete.
string	snapshot	A comma-separated list of snapshot names to delete from the repository.
DeleteSnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetAsync<TResponse>(string, string, GetSnapshotRequestParameters, CancellationToken)

GET on /_snapshot/{repository}/{snapshot}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GetAsync<TResponse>(string repository, string snapshot, GetSnapshotRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.
string	snapshot	A comma-separated list of snapshot names to retrieve. Also accepts wildcard expressions. (<c></c>). - To get information about all snapshots in a registered repository, use a wildcard (<c></c>) or <c>_all</c>. - To get information about any snapshots that are currently running, use <c>_current</c>.
GetSnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRepositoryAsync<TResponse>(GetRepositoryRequestParameters, CancellationToken)

GET on /_snapshot

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/

Declaration

public Task<TResponse> GetRepositoryAsync<TResponse>(GetRepositoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRepositoryAsync<TResponse>(string, GetRepositoryRequestParameters, CancellationToken)

GET on /_snapshot/{repository}

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/

Declaration

public Task<TResponse> GetRepositoryAsync<TResponse>(string repository, GetRepositoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	A comma-separated list of repository names.
GetRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRepository<TResponse>(GetRepositoryRequestParameters)

GET on /_snapshot

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/

Declaration

public TResponse GetRepository<TResponse>(GetRepositoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRepository<TResponse>(string, GetRepositoryRequestParameters)

GET on /_snapshot/{repository}

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/

Declaration

public TResponse GetRepository<TResponse>(string repository, GetRepositoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	A comma-separated list of repository names.
GetRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Get<TResponse>(string, string, GetSnapshotRequestParameters)

GET on /_snapshot/{repository}/{snapshot}

https://opensearch.org/docs/latest

Declaration

public TResponse Get<TResponse>(string repository, string snapshot, GetSnapshotRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.
string	snapshot	A comma-separated list of snapshot names to retrieve. Also accepts wildcard expressions. (<c></c>). - To get information about all snapshots in a registered repository, use a wildcard (<c></c>) or <c>_all</c>. - To get information about any snapshots that are currently running, use <c>_current</c>.
GetSnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

RestoreAsync<TResponse>(string, string, PostData, RestoreRequestParameters, CancellationToken)

POST on /_snapshot/{repository}/{snapshot}/_restore

https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/

Declaration

public Task<TResponse> RestoreAsync<TResponse>(string repository, string snapshot, PostData body, RestoreRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
string	snapshot	The name of the snapshot to restore.
PostData	body	Determines which settings and indexes to restore when restoring a snapshot.
RestoreRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Restore<TResponse>(string, string, PostData, RestoreRequestParameters)

POST on /_snapshot/{repository}/{snapshot}/_restore

https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/

Declaration

public TResponse Restore<TResponse>(string repository, string snapshot, PostData body, RestoreRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
string	snapshot	The name of the snapshot to restore.
PostData	body	Determines which settings and indexes to restore when restoring a snapshot.
RestoreRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

SnapshotAsync<TResponse>(string, string, PostData, SnapshotRequestParameters, CancellationToken)

PUT on /_snapshot/{repository}/{snapshot}

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/

Declaration

public Task<TResponse> SnapshotAsync<TResponse>(string repository, string snapshot, PostData body, SnapshotRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository where the snapshot will be stored.
string	snapshot	The name of the snapshot. Must be unique in the repository.
PostData	body	The snapshot definition.
SnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Snapshot<TResponse>(string, string, PostData, SnapshotRequestParameters)

PUT on /_snapshot/{repository}/{snapshot}

https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/

Declaration

public TResponse Snapshot<TResponse>(string repository, string snapshot, PostData body, SnapshotRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository where the snapshot will be stored.
string	snapshot	The name of the snapshot. Must be unique in the repository.
PostData	body	The snapshot definition.
SnapshotRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatusAsync<TResponse>(SnapshotStatusRequestParameters, CancellationToken)

GET on /_snapshot/_status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

Declaration

public Task<TResponse> StatusAsync<TResponse>(SnapshotStatusRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SnapshotStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatusAsync<TResponse>(string, SnapshotStatusRequestParameters, CancellationToken)

GET on /_snapshot/{repository}/_status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

Declaration

public Task<TResponse> StatusAsync<TResponse>(string repository, SnapshotStatusRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
SnapshotStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatusAsync<TResponse>(string, string, SnapshotStatusRequestParameters, CancellationToken)

GET on /_snapshot/{repository}/{snapshot}/_status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

Declaration

public Task<TResponse> StatusAsync<TResponse>(string repository, string snapshot, SnapshotStatusRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
string	snapshot	A comma-separated list of snapshot names.
SnapshotStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Status<TResponse>(SnapshotStatusRequestParameters)

GET on /_snapshot/_status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

Declaration

public TResponse Status<TResponse>(SnapshotStatusRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SnapshotStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Status<TResponse>(string, SnapshotStatusRequestParameters)

GET on /_snapshot/{repository}/_status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

Declaration

public TResponse Status<TResponse>(string repository, SnapshotStatusRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
SnapshotStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Status<TResponse>(string, string, SnapshotStatusRequestParameters)

GET on /_snapshot/{repository}/{snapshot}/_status

https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/

Declaration

public TResponse Status<TResponse>(string repository, string snapshot, SnapshotStatusRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
string	snapshot	A comma-separated list of snapshot names.
SnapshotStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

VerifyRepositoryAsync<TResponse>(string, VerifyRepositoryRequestParameters, CancellationToken)

POST on /_snapshot/{repository}/_verify

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/

Declaration

public Task<TResponse> VerifyRepositoryAsync<TResponse>(string repository, VerifyRepositoryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
VerifyRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

VerifyRepository<TResponse>(string, VerifyRepositoryRequestParameters)

POST on /_snapshot/{repository}/_verify

https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/

Declaration

public TResponse VerifyRepository<TResponse>(string repository, VerifyRepositoryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	repository	The name of the repository containing the snapshot.
VerifyRepositoryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)