Class CatHelpDescriptor
Descriptor for Help
https://opensearch.org/docs/latest/api-reference/cat/index/
Inheritance
CatHelpDescriptor
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatHelpDescriptor : RequestDescriptorBase<CatHelpDescriptor, CatHelpRequestParameters, ICatHelpRequest>, IDescriptor, ICatHelpRequest, IRequest<CatHelpRequestParameters>, IRequest
Methods
| Edit this page View SourceHelp(bool?)
Return help information.
Declaration
public CatHelpDescriptor Help(bool? help = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | help |
Returns
Type | Description |
---|---|
CatHelpDescriptor |
SortByColumns(params string[])
Comma-separated list of column names or column aliases to sort by.
Declaration
public CatHelpDescriptor SortByColumns(params string[] sortbycolumns)
Parameters
Type | Name | Description |
---|---|---|
string[] | sortbycolumns |
Returns
Type | Description |
---|---|
CatHelpDescriptor |