Class CatSnapshotsRequestParameters

Request options for Snapshots

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

Inheritance

object

RequestParameters<CatSnapshotsRequestParameters>

CatSnapshotsRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<CatSnapshotsRequestParameters>.CustomResponseBuilder

RequestParameters<CatSnapshotsRequestParameters>.QueryString

RequestParameters<CatSnapshotsRequestParameters>.RequestConfiguration

RequestParameters<CatSnapshotsRequestParameters>.ContainsQueryString(string)

RequestParameters<CatSnapshotsRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<CatSnapshotsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<CatSnapshotsRequestParameters>.SetQueryString(string, object)

RequestParameters<CatSnapshotsRequestParameters>.Q<TOut>(string)

RequestParameters<CatSnapshotsRequestParameters>.Q(string, object)

RequestParameters<CatSnapshotsRequestParameters>.SetAcceptHeader(string)

RequestParameters<CatSnapshotsRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.CatApi

Assembly: OpenSearch.Net.dll

Syntax

public class CatSnapshotsRequestParameters : RequestParameters<CatSnapshotsRequestParameters>, IRequestParameters

Properties

ClusterManagerTimeout

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

Declaration

public TimeSpan ClusterManagerTimeout { get; set; }

Property Value

Type	Description
TimeSpan

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<CatSnapshotsRequestParameters>.DefaultHttpMethod

Format

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

Declaration

public string Format { get; set; }

Property Value

Type	Description
string

Headers

A comma-separated list of column names to display.

Declaration

public string[] Headers { get; set; }

Property Value

Type	Description
string[]

Help

Returns help information.

Declaration

public bool? Help { get; set; }

Property Value

Type	Description
bool?

IgnoreUnavailable

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

Declaration

public bool? IgnoreUnavailable { get; set; }

Property Value

Type	Description
bool?

MasterTimeout

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 TimeSpan MasterTimeout { get; set; }

Property Value

Type	Description
TimeSpan

Repository

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 string[] Repository { get; set; }

Property Value

Type	Description
string[]

SortByColumns

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

Declaration

public string[] SortByColumns { get; set; }

Property Value

Type	Description
string[]

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<CatSnapshotsRequestParameters>.SupportsBody

Verbose

Enables verbose mode, which displays column headers.

Declaration

public bool? Verbose { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)