Class CatTemplatesDescriptor

Descriptor for Templates

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

Inheritance
object
RequestBase<CatTemplatesRequestParameters>
RequestDescriptorBase<CatTemplatesDescriptor, CatTemplatesRequestParameters, ICatTemplatesRequest>
CatTemplatesDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatTemplatesDescriptor : RequestDescriptorBase<CatTemplatesDescriptor, CatTemplatesRequestParameters, ICatTemplatesRequest>, IDescriptor, ICatTemplatesRequest, IRequest<CatTemplatesRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatTemplatesDescriptor()

/_cat/templates

Declaration
public CatTemplatesDescriptor()
| Edit this page View Source

CatTemplatesDescriptor(Name)

/_cat/templates/{name}

Declaration
public CatTemplatesDescriptor(Name name)
Parameters
Type Name Description
Name name

Optional, accepts null

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
public CatTemplatesDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatTemplatesDescriptor
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, such as json or yaml.

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

Headers(params string[])

A comma-separated list of column names to display.

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

Help(bool?)

Returns help information.

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

Local(bool?)

Returns local information but does not retrieve the state from the cluster manager node.

Declaration
public CatTemplatesDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
CatTemplatesDescriptor
| Edit this page View Source

MasterTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager 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
Type Description
CatTemplatesDescriptor
| 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
Type Description
CatTemplatesDescriptor
| Edit this page View Source

SortByColumns(params string[])

A 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
Type Description
CatTemplatesDescriptor
| Edit this page View Source

Verbose(bool?)

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods