Search Results for

    Show / Hide Table of Contents

    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
    IDescriptor
    ISnapshotStatusRequest
    IRequest<SnapshotStatusRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.Self
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.Assign<TValue>(TValue, Action<ISnapshotStatusRequest, TValue>)
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.Qs(string, object)
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.FilterPath(params string[])
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.Human(bool?)
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.Pretty(bool?)
    RequestDescriptorBase<SnapshotStatusDescriptor, SnapshotStatusRequestParameters, ISnapshotStatusRequest>.SourceQueryString(string)
    RequestBase<SnapshotStatusRequestParameters>.HttpMethod
    RequestBase<SnapshotStatusRequestParameters>.RequestState
    RequestBase<SnapshotStatusRequestParameters>.ContentType
    RequestBase<SnapshotStatusRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<SnapshotStatusRequestParameters>.RequestDefaults(SnapshotStatusRequestParameters)
    RequestBase<SnapshotStatusRequestParameters>.Q<TOut>(string)
    RequestBase<SnapshotStatusRequestParameters>.Q(string, object)
    RequestBase<SnapshotStatusRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    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)

    The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

    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 any unavailable snapshots, When false, 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)

    The name of the repository containing the snapshot.

    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

    IDescriptor
    ISnapshotStatusRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • SnapshotStatusDescriptor()
      • SnapshotStatusDescriptor(Name)
      • SnapshotStatusDescriptor(Name, Names)
    • Methods
      • ClusterManagerTimeout(Time)
      • IgnoreUnavailable(bool?)
      • MasterTimeout(Time)
      • RepositoryName(Name)
      • Snapshot(Names)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX