Search Results for

    Show / Hide Table of Contents

    Class CatPitSegmentsDescriptor

    Descriptor for PitSegments

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/

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

    Methods

    | Edit this page View Source

    Bytes(ByteUnit?)

    The units used to display byte values.

    Declaration
    public CatPitSegmentsDescriptor Bytes(ByteUnit? bytes)
    Parameters
    Type Name Description
    ByteUnit? bytes
    Returns
    Type Description
    CatPitSegmentsDescriptor
    | Edit this page View Source

    Format(string)

    A short version of the Accept header, such as json or yaml.

    Declaration
    public CatPitSegmentsDescriptor Format(string format)
    Parameters
    Type Name Description
    string format
    Returns
    Type Description
    CatPitSegmentsDescriptor
    | Edit this page View Source

    Headers(params string[])

    A comma-separated list of column names to display.

    Declaration
    public CatPitSegmentsDescriptor Headers(params string[] headers)
    Parameters
    Type Name Description
    string[] headers
    Returns
    Type Description
    CatPitSegmentsDescriptor
    | Edit this page View Source

    Help(bool?)

    Returns help information.

    Declaration
    public CatPitSegmentsDescriptor Help(bool? help = true)
    Parameters
    Type Name Description
    bool? help
    Returns
    Type Description
    CatPitSegmentsDescriptor
    | Edit this page View Source

    PitId(IEnumerable<string>)

    Declaration
    public CatPitSegmentsDescriptor PitId(IEnumerable<string> pitId)
    Parameters
    Type Name Description
    IEnumerable<string> pitId
    Returns
    Type Description
    CatPitSegmentsDescriptor
    | Edit this page View Source

    PitId(params string[])

    Declaration
    public CatPitSegmentsDescriptor PitId(params string[] pitId)
    Parameters
    Type Name Description
    string[] pitId
    Returns
    Type Description
    CatPitSegmentsDescriptor
    | Edit this page View Source

    SortByColumns(params string[])

    A comma-separated list of column names or column aliases to sort by.

    Declaration
    public CatPitSegmentsDescriptor SortByColumns(params string[] sortbycolumns)
    Parameters
    Type Name Description
    string[] sortbycolumns
    Returns
    Type Description
    CatPitSegmentsDescriptor
    | Edit this page View Source

    Verbose(bool?)

    Enables verbose mode, which displays column headers.

    Declaration
    public CatPitSegmentsDescriptor Verbose(bool? verbose = true)
    Parameters
    Type Name Description
    bool? verbose
    Returns
    Type Description
    CatPitSegmentsDescriptor

    Implements

    IDescriptor
    ICatPitSegmentsRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • Bytes(ByteUnit?)
      • Format(string)
      • Headers(params string[])
      • Help(bool?)
      • PitId(IEnumerable<string>)
      • PitId(params string[])
      • SortByColumns(params string[])
      • Verbose(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX