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)

Operation timeout for connection to cluster-manager node.

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

Local(bool?)

If true, the request retrieves information from the local node only. If false, information is retrieved from the master 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)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

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)

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