Search Results for

    Show / Hide Table of Contents

    Class SnapshotStatusRequestParameters

    Request options for Status

    <p>https://docs.opensearch.org/latest/api-reference/snapshots/get-snapshot-status/</p>
    
    Inheritance
    object
    RequestParameters<SnapshotStatusRequestParameters>
    SnapshotStatusRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<SnapshotStatusRequestParameters>.CustomResponseBuilder
    RequestParameters<SnapshotStatusRequestParameters>.QueryString
    RequestParameters<SnapshotStatusRequestParameters>.RequestConfiguration
    RequestParameters<SnapshotStatusRequestParameters>.ContainsQueryString(string)
    RequestParameters<SnapshotStatusRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<SnapshotStatusRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<SnapshotStatusRequestParameters>.SetQueryString(string, object)
    RequestParameters<SnapshotStatusRequestParameters>.Q<TOut>(string)
    RequestParameters<SnapshotStatusRequestParameters>.Q(string, object)
    RequestParameters<SnapshotStatusRequestParameters>.SetAcceptHeader(string)
    RequestParameters<SnapshotStatusRequestParameters>.SetAcceptHeader(Enum)
    RequestParameters<SnapshotStatusRequestParameters>.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.SnapshotApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class SnapshotStatusRequestParameters : RequestParameters<SnapshotStatusRequestParameters>, IRequestParameters

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

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<SnapshotStatusRequestParameters>.DefaultHttpMethod
    | 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 TimeSpan MasterTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    OperationName

    The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

    Declaration
    public override string OperationName { get; }
    Property Value
    Type Description
    string
    Overrides
    RequestParameters<SnapshotStatusRequestParameters>.OperationName
    | Edit this page View Source

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<SnapshotStatusRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX