Class GetComponentTemplateRequest

Request for GetComponentTemplate

https://opensearch.org/docs/latest

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

Constructors

| Edit this page View Source

GetComponentTemplateRequest()

/_component_template

Declaration
public GetComponentTemplateRequest()
| Edit this page View Source

GetComponentTemplateRequest(Name)

/_component_template/{name}

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

Optional, accepts null

Properties

| Edit this page View Source

ClusterManagerTimeout

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 Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

FlatSettings

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 bool? FlatSettings { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Local

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

Declaration
public bool? Local { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MasterTimeout

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 Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected IGetComponentTemplateRequest Self { get; }
Property Value
Type Description
IGetComponentTemplateRequest

Implements

Extension Methods