Class CatPitSegmentsRequest

Request for PitSegments

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

Inheritance
object
RequestBase<CatPitSegmentsRequestParameters>
PlainRequestBase<CatPitSegmentsRequestParameters>
CatPitSegmentsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatPitSegmentsRequest : PlainRequestBase<CatPitSegmentsRequestParameters>, ICatPitSegmentsRequest, IRequest<CatPitSegmentsRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatPitSegmentsRequest()

Declaration
public CatPitSegmentsRequest()
| Edit this page View Source

CatPitSegmentsRequest(IEnumerable<string>)

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

CatPitSegmentsRequest(params string[])

Declaration
public CatPitSegmentsRequest(params string[] pitId)
Parameters
Type Name Description
string[] pitId

Properties

| Edit this page View Source

Bytes

The units used to display byte values.

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

Format

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

Declaration
public string Format { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Headers

A comma-separated list of column names to display.

Declaration
public string[] Headers { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Help

Returns help information.

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

PitId

Declaration
public IEnumerable<string> PitId { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

Self

Declaration
protected ICatPitSegmentsRequest Self { get; }
Property Value
Type Description
ICatPitSegmentsRequest
| Edit this page View Source

SortByColumns

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

Declaration
public string[] SortByColumns { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Verbose

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods