Class CatSnapshotsDescriptor

Descriptor for Snapshots

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

Inheritance
object
RequestBase<CatSnapshotsRequestParameters>
RequestDescriptorBase<CatSnapshotsDescriptor, CatSnapshotsRequestParameters, ICatSnapshotsRequest>
CatSnapshotsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatSnapshotsDescriptor : RequestDescriptorBase<CatSnapshotsDescriptor, CatSnapshotsRequestParameters, ICatSnapshotsRequest>, IDescriptor, ICatSnapshotsRequest, IRequest<CatSnapshotsRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatSnapshotsDescriptor()

/_cat/snapshots

Declaration
public CatSnapshotsDescriptor()
| Edit this page View Source

CatSnapshotsDescriptor(Names)

/_cat/snapshots/{repository}

Declaration
public CatSnapshotsDescriptor(Names repository)
Parameters
Type Name Description
Names repository

Optional, accepts null

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
public CatSnapshotsDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatSnapshotsDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Format(string)

A short version of the Accept header, such as json or yaml.

Declaration
public CatSnapshotsDescriptor Format(string format)
Parameters
Type Name Description
string format
Returns
Type Description
CatSnapshotsDescriptor
| Edit this page View Source

Headers(params string[])

A comma-separated list of column names to display.

Declaration
public CatSnapshotsDescriptor Headers(params string[] headers)
Parameters
Type Name Description
string[] headers
Returns
Type Description
CatSnapshotsDescriptor
| Edit this page View Source

Help(bool?)

Returns help information.

Declaration
public CatSnapshotsDescriptor Help(bool? help = true)
Parameters
Type Name Description
bool? help
Returns
Type Description
CatSnapshotsDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

When true, the response does not include information from unavailable snapshots.

Declaration
public CatSnapshotsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
CatSnapshotsDescriptor
| Edit this page View Source

MasterTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CatSnapshotsDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CatSnapshotsDescriptor
| Edit this page View Source

RepositoryName(Names)

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, OpenSearch returns an error.

Declaration
public CatSnapshotsDescriptor RepositoryName(Names repository)
Parameters
Type Name Description
Names repository
Returns
Type Description
CatSnapshotsDescriptor
| Edit this page View Source

SortByColumns(params string[])

A comma-separated list of column names or column aliases to sort by.

Declaration
public CatSnapshotsDescriptor SortByColumns(params string[] sortbycolumns)
Parameters
Type Name Description
string[] sortbycolumns
Returns
Type Description
CatSnapshotsDescriptor
| Edit this page View Source

Verbose(bool?)

Enables verbose mode, which displays column headers.

Declaration
public CatSnapshotsDescriptor Verbose(bool? verbose = true)
Parameters
Type Name Description
bool? verbose
Returns
Type Description
CatSnapshotsDescriptor

Implements

Extension Methods