Class CatFielddataRequest

Request for Fielddata

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

Inheritance
object
RequestBase<CatFielddataRequestParameters>
PlainRequestBase<CatFielddataRequestParameters>
CatFielddataRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatFielddataRequest : PlainRequestBase<CatFielddataRequestParameters>, ICatFielddataRequest, IRequest<CatFielddataRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatFielddataRequest()

/_cat/fielddata

Declaration
public CatFielddataRequest()
| Edit this page View Source

CatFielddataRequest(Fields)

/_cat/fielddata/{fields}

Declaration
public CatFielddataRequest(Fields fields)
Parameters
Type Name Description
Fields fields

Optional, accepts null

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

Self

Declaration
protected ICatFielddataRequest Self { get; }
Property Value
Type Description
ICatFielddataRequest
| 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