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
Inherited Members
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 unit in which 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, e.g. json, 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[])

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?)

Return 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[])

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?)

Verbose mode. Display column headers.

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

Implements

Extension Methods