Class CatTemplatesDescriptor
Descriptor for Templates
https://opensearch.org/docs/latest/api-reference/cat/cat-templates/
Inheritance
CatTemplatesDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class CatTemplatesDescriptor : RequestDescriptorBase<CatTemplatesDescriptor, CatTemplatesRequestParameters, ICatTemplatesRequest>, IDescriptor, ICatTemplatesRequest, IRequest<CatTemplatesRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
CatTemplatesDescriptor()
Declaration
public CatTemplatesDescriptor()
|
Edit this page
View Source
CatTemplatesDescriptor(Name)
Declaration
public CatTemplatesDescriptor(Name name)
Parameters
Type |
Name |
Description |
Name |
name |
Optional, accepts null
|
Methods
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Operation timeout for connection to cluster-manager node.
Declaration
public CatTemplatesDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type |
Name |
Description |
Time |
clustermanagertimeout |
|
Returns
|
Edit this page
View Source
A short version of the Accept header, e.g. json, yaml.
Declaration
public CatTemplatesDescriptor Format(string format)
Parameters
Type |
Name |
Description |
string |
format |
|
Returns
|
Edit this page
View Source
Comma-separated list of column names to display.
Declaration
public CatTemplatesDescriptor Headers(params string[] headers)
Parameters
Type |
Name |
Description |
string[] |
headers |
|
Returns
|
Edit this page
View Source
Help(bool?)
Declaration
public CatTemplatesDescriptor Help(bool? help = true)
Parameters
Type |
Name |
Description |
bool? |
help |
|
Returns
|
Edit this page
View Source
Local(bool?)
Return local information, do not retrieve the state from cluster-manager node.
Declaration
public CatTemplatesDescriptor Local(bool? local = true)
Parameters
Type |
Name |
Description |
bool? |
local |
|
Returns
|
Edit this page
View Source
MasterTimeout(Time)
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 CatTemplatesDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Name(Name)
The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
Declaration
public CatTemplatesDescriptor Name(Name name)
Parameters
Type |
Name |
Description |
Name |
name |
|
Returns
|
Edit this page
View Source
SortByColumns(params string[])
Comma-separated list of column names or column aliases to sort by.
Declaration
public CatTemplatesDescriptor SortByColumns(params string[] sortbycolumns)
Parameters
Type |
Name |
Description |
string[] |
sortbycolumns |
|
Returns
|
Edit this page
View Source
Verbose(bool?)
Verbose mode. Display column headers.
Declaration
public CatTemplatesDescriptor Verbose(bool? verbose = true)
Parameters
Type |
Name |
Description |
bool? |
verbose |
|
Returns
Implements
Extension Methods