Class SnapshotStatusDescriptor

Descriptor for Status

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

Inheritance
object
RequestBase<SnapshotStatusRequestParameters>
RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>
SnapshotStatusDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SnapshotStatusDescriptor : RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>, IDescriptor, ISnapshotStatusRequest, IRequest<SnapshotStatusRequestParameters>, IRequest

Constructors

| Edit this page View Source

SnapshotStatusDescriptor()

/_snapshot/_status

Declaration
public SnapshotStatusDescriptor()
| Edit this page View Source

SnapshotStatusDescriptor(Name)

/_snapshot/{repository}/_status

Declaration
public SnapshotStatusDescriptor(Name repository)
Parameters
Type Name Description
Name repository

Optional, accepts null
| Edit this page View Source

SnapshotStatusDescriptor(Name, Names)

/_snapshot/{repository}/{snapshot}/_status

Declaration
public SnapshotStatusDescriptor(Name repository, Names snapshot)
Parameters
Type Name Description
Name repository

Optional, accepts null
Names snapshot

Optional, accepts null

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

IgnoreUnavailable(bool?)

Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.

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

MasterTimeout(Time)

Explicit operation timeout for connection to cluster-manager node.

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

RepositoryName(Name)

A repository name.

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

Snapshot(Names)

A comma-separated list of snapshot names.

Declaration
public SnapshotStatusDescriptor Snapshot(Names snapshot)
Parameters
Type Name Description
Names snapshot
Returns
Type Description
SnapshotStatusDescriptor

Implements

Extension Methods