Search Results for

    Show / Hide Table of Contents

    Class GetRepositoryDescriptor

    Descriptor for GetRepository

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

    Inheritance
    object
    RequestBase<GetRepositoryRequestParameters>
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>
    GetRepositoryDescriptor
    Implements
    IDescriptor
    IGetRepositoryRequest
    IRequest<GetRepositoryRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.Self
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.Assign<TValue>(TValue, Action<IGetRepositoryRequest, TValue>)
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.Qs(string, object)
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.FilterPath(params string[])
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.Human(bool?)
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.Pretty(bool?)
    RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>.SourceQueryString(string)
    RequestBase<GetRepositoryRequestParameters>.HttpMethod
    RequestBase<GetRepositoryRequestParameters>.RequestState
    RequestBase<GetRepositoryRequestParameters>.ContentType
    RequestBase<GetRepositoryRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<GetRepositoryRequestParameters>.RequestDefaults(GetRepositoryRequestParameters)
    RequestBase<GetRepositoryRequestParameters>.Q<TOut>(string)
    RequestBase<GetRepositoryRequestParameters>.Q(string, object)
    RequestBase<GetRepositoryRequestParameters>.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 GetRepositoryDescriptor : RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>, IDescriptor, IGetRepositoryRequest, IRequest<GetRepositoryRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    GetRepositoryDescriptor()

    /_snapshot

    Declaration
    public GetRepositoryDescriptor()
    | Edit this page View Source

    GetRepositoryDescriptor(Names)

    /_snapshot/{repository}

    Declaration
    public GetRepositoryDescriptor(Names repository)
    Parameters
    Type Name Description
    Names repository

    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 GetRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    GetRepositoryDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Local(bool?)

    Whether to get information from the local node.

    Declaration
    public GetRepositoryDescriptor Local(bool? local = true)
    Parameters
    Type Name Description
    bool? local
    Returns
    Type Description
    GetRepositoryDescriptor
    | 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 GetRepositoryDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    GetRepositoryDescriptor
    | Edit this page View Source

    RepositoryName(Names)

    A comma-separated list of repository names.

    Declaration
    public GetRepositoryDescriptor RepositoryName(Names repository)
    Parameters
    Type Name Description
    Names repository
    Returns
    Type Description
    GetRepositoryDescriptor

    Implements

    IDescriptor
    IGetRepositoryRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

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