Search Results for

    Show / Hide Table of Contents

    Class GetSnapshotRequestParameters

    Request options for Get

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestParameters<GetSnapshotRequestParameters>
    GetSnapshotRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<GetSnapshotRequestParameters>.CustomResponseBuilder
    RequestParameters<GetSnapshotRequestParameters>.QueryString
    RequestParameters<GetSnapshotRequestParameters>.RequestConfiguration
    RequestParameters<GetSnapshotRequestParameters>.ContainsQueryString(string)
    RequestParameters<GetSnapshotRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<GetSnapshotRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<GetSnapshotRequestParameters>.SetQueryString(string, object)
    RequestParameters<GetSnapshotRequestParameters>.Q<TOut>(string)
    RequestParameters<GetSnapshotRequestParameters>.Q(string, object)
    RequestParameters<GetSnapshotRequestParameters>.SetAcceptHeader(string)
    RequestParameters<GetSnapshotRequestParameters>.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 GetSnapshotRequestParameters : RequestParameters<GetSnapshotRequestParameters>, 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<GetSnapshotRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    IgnoreUnavailable

    When false, the request returns an error for any snapshots that are unavailable.

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

    MasterTimeout

    Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

    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

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<GetSnapshotRequestParameters>.SupportsBody
    | Edit this page View Source

    Verbose

    When true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards contained in the snapshot.

    Declaration
    public bool? Verbose { get; set; }
    Property Value
    Type Description
    bool?

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • ClusterManagerTimeout
      • DefaultHttpMethod
      • IgnoreUnavailable
      • MasterTimeout
      • SupportsBody
      • Verbose
    • Implements
    • Extension Methods
    Back to top Generated by DocFX