Search Results for

    Show / Hide Table of Contents

    Class SnapshotStatusRequest

    Request for Status

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

    Inheritance
    object
    RequestBase<SnapshotStatusRequestParameters>
    PlainRequestBase<SnapshotStatusRequestParameters>
    SnapshotStatusRequest
    Implements
    ISnapshotStatusRequest
    IRequest<SnapshotStatusRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<SnapshotStatusRequestParameters>.RequestConfiguration
    PlainRequestBase<SnapshotStatusRequestParameters>.ErrorTrace
    PlainRequestBase<SnapshotStatusRequestParameters>.FilterPath
    PlainRequestBase<SnapshotStatusRequestParameters>.Human
    PlainRequestBase<SnapshotStatusRequestParameters>.Pretty
    PlainRequestBase<SnapshotStatusRequestParameters>.SourceQueryString
    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 SnapshotStatusRequest : PlainRequestBase<SnapshotStatusRequestParameters>, ISnapshotStatusRequest, IRequest<SnapshotStatusRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    SnapshotStatusRequest()

    /_snapshot/_status

    Declaration
    public SnapshotStatusRequest()
    | Edit this page View Source

    SnapshotStatusRequest(Name)

    /_snapshot/{repository}/_status

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

    Optional, accepts null

    | Edit this page View Source

    SnapshotStatusRequest(Name, Names)

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

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

    Optional, accepts null

    Names snapshot

    Optional, accepts null

    Properties

    | Edit this page View Source

    ClusterManagerTimeout

    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 Time ClusterManagerTimeout { get; set; }
    Property Value
    Type Description
    Time
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    IgnoreUnavailable

    Whether to ignore any unavailable snapshots, When false, a SnapshotMissingException is thrown.

    Declaration
    public bool? IgnoreUnavailable { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    MasterTimeout

    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 Time MasterTimeout { get; set; }
    Property Value
    Type Description
    Time
    | Edit this page View Source

    Self

    Declaration
    protected ISnapshotStatusRequest Self { get; }
    Property Value
    Type Description
    ISnapshotStatusRequest

    Implements

    ISnapshotStatusRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • SnapshotStatusRequest()
      • SnapshotStatusRequest(Name)
      • SnapshotStatusRequest(Name, Names)
    • Properties
      • ClusterManagerTimeout
      • IgnoreUnavailable
      • MasterTimeout
      • Self
    • Implements
    • Extension Methods
    Back to top Generated by DocFX