Class GetComponentTemplateDescriptor

Descriptor for GetComponentTemplate

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<GetComponentTemplateRequestParameters>
RequestDescriptorBase<GetComponentTemplateDescriptor, GetComponentTemplateRequestParameters, IGetComponentTemplateRequest>
GetComponentTemplateDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetComponentTemplateDescriptor : RequestDescriptorBase<GetComponentTemplateDescriptor, GetComponentTemplateRequestParameters, IGetComponentTemplateRequest>, IDescriptor, IGetComponentTemplateRequest, IRequest<GetComponentTemplateRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetComponentTemplateDescriptor()

/_component_template

Declaration
public GetComponentTemplateDescriptor()
| Edit this page View Source

GetComponentTemplateDescriptor(Name)

/_component_template/{name}

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

Optional, accepts null

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

Declaration
public GetComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
GetComponentTemplateDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

FlatSettings(bool?)

Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

Declaration
public GetComponentTemplateDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
GetComponentTemplateDescriptor
| Edit this page View Source

Local(bool?)

When true, the request retrieves information from the local node only. When false, information is retrieved from the cluster manager node.

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

MasterTimeout(Time)

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public GetComponentTemplateDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
GetComponentTemplateDescriptor
| Edit this page View Source

Name(Name)

The name of the component template to retrieve. Wildcard (*) expressions are supported.

Declaration
public GetComponentTemplateDescriptor Name(Name name)
Parameters
Type Name Description
Name name
Returns
Type Description
GetComponentTemplateDescriptor

Implements

Extension Methods