Class CatSegmentsDescriptor

Descriptor for Segments

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

Inheritance
object
RequestBase<CatSegmentsRequestParameters>
RequestDescriptorBase<CatSegmentsDescriptor, CatSegmentsRequestParameters, ICatSegmentsRequest>
CatSegmentsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatSegmentsDescriptor : RequestDescriptorBase<CatSegmentsDescriptor, CatSegmentsRequestParameters, ICatSegmentsRequest>, IDescriptor, ICatSegmentsRequest, IRequest<CatSegmentsRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatSegmentsDescriptor()

/_cat/segments

Declaration
public CatSegmentsDescriptor()
| Edit this page View Source

CatSegmentsDescriptor(Indices)

/_cat/segments/{index}

Declaration
public CatSegmentsDescriptor(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public CatSegmentsDescriptor AllIndices()
Returns
Type Description
CatSegmentsDescriptor
| Edit this page View Source

Bytes(ByteUnit?)

The unit used to display byte values.

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

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public CatSegmentsDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatSegmentsDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Format(string)

A short version of the Accept header (for example, json, yaml).

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

Headers(params string[])

Comma-separated list of column names to display.

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

Help(bool?)

Return help information.

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

Index(Indices)

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

Declaration
public CatSegmentsDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
CatSegmentsDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public CatSegmentsDescriptor Index<TOther>() where TOther : class
Returns
Type Description
CatSegmentsDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

MasterTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CatSegmentsDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CatSegmentsDescriptor
| Edit this page View Source

SortByColumns(params string[])

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

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

Verbose(bool?)

Verbose mode. Display column headers.

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

Implements

Extension Methods