Class CatFielddataDescriptor

Descriptor for Fielddata

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

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

Constructors

| Edit this page View Source

CatFielddataDescriptor()

/_cat/fielddata

Declaration
public CatFielddataDescriptor()
| Edit this page View Source

CatFielddataDescriptor(Fields)

/_cat/fielddata/{fields}

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

Optional, accepts null

Methods

| Edit this page View Source

Bytes(ByteUnit?)

The units used to display byte values.

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

Fields(Fields)

A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.

Declaration
public CatFielddataDescriptor Fields(Fields fields)
Parameters
Type Name Description
Fields fields
Returns
Type Description
CatFielddataDescriptor
| Edit this page View Source

Fields<T>(params Expression<Func<T, object>>[])

A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.

Declaration
public CatFielddataDescriptor Fields<T>(params Expression<Func<T, object>>[] fields)
Parameters
Type Name Description
Expression<Func<T, object>>[] fields
Returns
Type Description
CatFielddataDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Format(string)

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

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

Headers(params string[])

A comma-separated list of column names to display.

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

Help(bool?)

Returns help information.

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

SortByColumns(params string[])

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

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

Verbose(bool?)

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods