Class CatAllPitSegmentsDescriptor

Descriptor for AllPitSegments

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

Inheritance

object

RequestBase<CatAllPitSegmentsRequestParameters>

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>

CatAllPitSegmentsDescriptor

Implements

IDescriptor

ICatAllPitSegmentsRequest

IRequest<CatAllPitSegmentsRequestParameters>

IRequest

Inherited Members

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.Self

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.Assign<TValue>(TValue, Action<ICatAllPitSegmentsRequest, TValue>)

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.Qs(string, object)

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.ErrorTrace(bool?)

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.FilterPath(params string[])

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.FilterPath(IEnumerable<string>)

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.Human(bool?)

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.Pretty(bool?)

RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>.SourceQueryString(string)

RequestBase<CatAllPitSegmentsRequestParameters>.HttpMethod

RequestBase<CatAllPitSegmentsRequestParameters>.RequestState

RequestBase<CatAllPitSegmentsRequestParameters>.ContentType

RequestBase<CatAllPitSegmentsRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<CatAllPitSegmentsRequestParameters>.RequestDefaults(CatAllPitSegmentsRequestParameters)

RequestBase<CatAllPitSegmentsRequestParameters>.Q<TOut>(string)

RequestBase<CatAllPitSegmentsRequestParameters>.Q(string, object)

RequestBase<CatAllPitSegmentsRequestParameters>.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 CatAllPitSegmentsDescriptor : RequestDescriptorBase<CatAllPitSegmentsDescriptor, CatAllPitSegmentsRequestParameters, ICatAllPitSegmentsRequest>, IDescriptor, ICatAllPitSegmentsRequest, IRequest<CatAllPitSegmentsRequestParameters>, IRequest

Methods

Bytes(ByteUnit?)

The units used to display byte values.

Declaration

public CatAllPitSegmentsDescriptor Bytes(ByteUnit? bytes)

Parameters

Type	Name	Description
ByteUnit?	bytes

Returns

Type	Description
CatAllPitSegmentsDescriptor

Format(string)

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

Declaration

public CatAllPitSegmentsDescriptor Format(string format)

Parameters

Type	Name	Description
string	format

Returns

Type	Description
CatAllPitSegmentsDescriptor

Headers(params string[])

A comma-separated list of column names to display.

Declaration

public CatAllPitSegmentsDescriptor Headers(params string[] headers)

Parameters

Type	Name	Description
string[]	headers

Returns

Type	Description
CatAllPitSegmentsDescriptor

Help(bool?)

Returns help information.

Declaration

public CatAllPitSegmentsDescriptor Help(bool? help = true)

Parameters

Type	Name	Description
bool?	help

Returns

Type	Description
CatAllPitSegmentsDescriptor

SortByColumns(params string[])

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

Declaration

public CatAllPitSegmentsDescriptor SortByColumns(params string[] sortbycolumns)

Parameters

Type	Name	Description
string[]	sortbycolumns

Returns

Type	Description
CatAllPitSegmentsDescriptor

Verbose(bool?)

Enables verbose mode, which displays column headers.

Declaration

public CatAllPitSegmentsDescriptor Verbose(bool? verbose = true)

Parameters

Type	Name	Description
bool?	verbose

Returns

Type	Description
CatAllPitSegmentsDescriptor

Implements

IDescriptor

ICatAllPitSegmentsRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)