Class CatSegmentsRequestParameters

Request options for Segments

https://opensearch.org/docs/latest/api-reference/cat/cat-segments/

Inheritance
object
RequestParameters<CatSegmentsRequestParameters>
CatSegmentsRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.CatApi
Assembly: OpenSearch.Net.dll
Syntax
public class CatSegmentsRequestParameters : RequestParameters<CatSegmentsRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

Bytes

The unit used to display byte values.

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

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public TimeSpan ClusterManagerTimeout { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

Format

A short version of the Accept header, e.g. json, yaml.

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

Headers

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

Return help information.

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

MasterTimeout

Operation timeout for connection to master node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead.")]
public TimeSpan MasterTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

SortByColumns

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

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Verbose

Verbose mode. Display column headers.

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

Implements

Extension Methods