Class LowLevelClusterNamespace

Cluster APIs.

Not intended to be instantiated directly. Use the Cluster property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelClusterNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.ClusterApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelClusterNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

AllocationExplainAsync<TResponse>(PostData, ClusterAllocationExplainRequestParameters, CancellationToken)

POST on /_cluster/allocation/explain

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/

Declaration

public Task<TResponse> AllocationExplainAsync<TResponse>(PostData body, ClusterAllocationExplainRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'.
ClusterAllocationExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

AllocationExplain<TResponse>(PostData, ClusterAllocationExplainRequestParameters)

POST on /_cluster/allocation/explain

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/

Declaration

public TResponse AllocationExplain<TResponse>(PostData body, ClusterAllocationExplainRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'.
ClusterAllocationExplainRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ComponentTemplateExistsAsync<TResponse>(string, ComponentTemplateExistsRequestParameters, CancellationToken)

HEAD on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ComponentTemplateExistsAsync<TResponse>(string name, ComponentTemplateExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to check existence of. Wildcard (*) expressions are supported.
ComponentTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ComponentTemplateExists<TResponse>(string, ComponentTemplateExistsRequestParameters)

HEAD on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse ComponentTemplateExists<TResponse>(string name, ComponentTemplateExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to check existence of. Wildcard (*) expressions are supported.
ComponentTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteComponentTemplateAsync<TResponse>(string, DeleteComponentTemplateRequestParameters, CancellationToken)

DELETE on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> DeleteComponentTemplateAsync<TResponse>(string name, DeleteComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to delete. Wildcard (*) expressions are supported.
DeleteComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteComponentTemplate<TResponse>(string, DeleteComponentTemplateRequestParameters)

DELETE on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse DeleteComponentTemplate<TResponse>(string name, DeleteComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to delete. Wildcard (*) expressions are supported.
DeleteComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteDecommissionAwarenessAsync<TResponse>(DeleteDecommissionAwarenessRequestParameters, CancellationToken)

DELETE on /_cluster/decommission/awareness

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public Task<TResponse> DeleteDecommissionAwarenessAsync<TResponse>(DeleteDecommissionAwarenessRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteDecommissionAwareness<TResponse>(DeleteDecommissionAwarenessRequestParameters)

DELETE on /_cluster/decommission/awareness

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public TResponse DeleteDecommissionAwareness<TResponse>(DeleteDecommissionAwarenessRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteVotingConfigExclusionsAsync<TResponse>(DeleteVotingConfigExclusionsRequestParameters, CancellationToken)

DELETE on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> DeleteVotingConfigExclusionsAsync<TResponse>(DeleteVotingConfigExclusionsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteVotingConfigExclusions<TResponse>(DeleteVotingConfigExclusionsRequestParameters)

DELETE on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public TResponse DeleteVotingConfigExclusions<TResponse>(DeleteVotingConfigExclusionsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteWeightedRoutingAsync<TResponse>(PostData, DeleteWeightedRoutingRequestParameters, CancellationToken)

DELETE on /_cluster/routing/awareness/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights

Declaration

public Task<TResponse> DeleteWeightedRoutingAsync<TResponse>(PostData body, DeleteWeightedRoutingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
DeleteWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteWeightedRouting<TResponse>(PostData, DeleteWeightedRoutingRequestParameters)

DELETE on /_cluster/routing/awareness/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights

Declaration

public TResponse DeleteWeightedRouting<TResponse>(PostData body, DeleteWeightedRoutingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
DeleteWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetComponentTemplateAsync<TResponse>(GetComponentTemplateRequestParameters, CancellationToken)

GET on /_component_template

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GetComponentTemplateAsync<TResponse>(GetComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetComponentTemplateAsync<TResponse>(string, GetComponentTemplateRequestParameters, CancellationToken)

GET on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GetComponentTemplateAsync<TResponse>(string name, GetComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to retrieve. Wildcard (`*`) expressions are supported.
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetComponentTemplate<TResponse>(GetComponentTemplateRequestParameters)

GET on /_component_template

https://opensearch.org/docs/latest

Declaration

public TResponse GetComponentTemplate<TResponse>(GetComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetComponentTemplate<TResponse>(string, GetComponentTemplateRequestParameters)

GET on /_component_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse GetComponentTemplate<TResponse>(string name, GetComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to retrieve. Wildcard (`*`) expressions are supported.
GetComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetDecommissionAwarenessAsync<TResponse>(string, GetDecommissionAwarenessRequestParameters, CancellationToken)

GET on /_cluster/decommission/awareness/{awareness_attribute_name}/_status

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status

Declaration

public Task<TResponse> GetDecommissionAwarenessAsync<TResponse>(string awarenessAttributeName, GetDecommissionAwarenessRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	Awareness attribute name.
GetDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetDecommissionAwareness<TResponse>(string, GetDecommissionAwarenessRequestParameters)

GET on /_cluster/decommission/awareness/{awareness_attribute_name}/_status

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status

Declaration

public TResponse GetDecommissionAwareness<TResponse>(string awarenessAttributeName, GetDecommissionAwarenessRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	Awareness attribute name.
GetDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetSettingsAsync<TResponse>(ClusterGetSettingsRequestParameters, CancellationToken)

GET on /_cluster/settings

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

Declaration

public Task<TResponse> GetSettingsAsync<TResponse>(ClusterGetSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterGetSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetSettings<TResponse>(ClusterGetSettingsRequestParameters)

GET on /_cluster/settings

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/

Declaration

public TResponse GetSettings<TResponse>(ClusterGetSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterGetSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetWeightedRoutingAsync<TResponse>(string, GetWeightedRoutingRequestParameters, CancellationToken)

GET on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones

Declaration

public Task<TResponse> GetWeightedRoutingAsync<TResponse>(string attribute, GetWeightedRoutingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	Awareness attribute name.
GetWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetWeightedRouting<TResponse>(string, GetWeightedRoutingRequestParameters)

GET on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones

Declaration

public TResponse GetWeightedRouting<TResponse>(string attribute, GetWeightedRoutingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	Awareness attribute name.
GetWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

HealthAsync<TResponse>(ClusterHealthRequestParameters, CancellationToken)

GET on /_cluster/health

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

Declaration

public Task<TResponse> HealthAsync<TResponse>(ClusterHealthRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

HealthAsync<TResponse>(string, ClusterHealthRequestParameters, CancellationToken)

GET on /_cluster/health/{index}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

Declaration

public Task<TResponse> HealthAsync<TResponse>(string index, ClusterHealthRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions () are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or ``.
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Health<TResponse>(ClusterHealthRequestParameters)

GET on /_cluster/health

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

Declaration

public TResponse Health<TResponse>(ClusterHealthRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Health<TResponse>(string, ClusterHealthRequestParameters)

GET on /_cluster/health/{index}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/

Declaration

public TResponse Health<TResponse>(string index, ClusterHealthRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions () are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or ``.
ClusterHealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PendingTasksAsync<TResponse>(ClusterPendingTasksRequestParameters, CancellationToken)

GET on /_cluster/pending_tasks

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> PendingTasksAsync<TResponse>(ClusterPendingTasksRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterPendingTasksRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PendingTasks<TResponse>(ClusterPendingTasksRequestParameters)

GET on /_cluster/pending_tasks

https://opensearch.org/docs/latest

Declaration

public TResponse PendingTasks<TResponse>(ClusterPendingTasksRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterPendingTasksRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PostVotingConfigExclusionsAsync<TResponse>(PostVotingConfigExclusionsRequestParameters, CancellationToken)

POST on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> PostVotingConfigExclusionsAsync<TResponse>(PostVotingConfigExclusionsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PostVotingConfigExclusions<TResponse>(PostVotingConfigExclusionsRequestParameters)

POST on /_cluster/voting_config_exclusions

https://opensearch.org/docs/latest

Declaration

public TResponse PostVotingConfigExclusions<TResponse>(PostVotingConfigExclusionsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostVotingConfigExclusionsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutComponentTemplateAsync<TResponse>(string, PostData, PutComponentTemplateRequestParameters, CancellationToken)

PUT on /_component_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public Task<TResponse> PutComponentTemplateAsync<TResponse>(string name, PostData body, PutComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`;` metrics-mappings`;` metrics-settings`;`synthetics-mapping`;` synthetics-settings`. OpenSearch Agent uses these templates to configure backing indices for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the` version`for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set`stack.templates.enabled`to`false` using the cluster update settings API.
PostData	body	The template definition.
PutComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutComponentTemplate<TResponse>(string, PostData, PutComponentTemplateRequestParameters)

PUT on /_component_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template

Declaration

public TResponse PutComponentTemplate<TResponse>(string name, PostData body, PutComponentTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`;` metrics-mappings`;` metrics-settings`;`synthetics-mapping`;` synthetics-settings`. OpenSearch Agent uses these templates to configure backing indices for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the` version`for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set`stack.templates.enabled`to`false` using the cluster update settings API.
PostData	body	The template definition.
PutComponentTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutDecommissionAwarenessAsync<TResponse>(string, string, PutDecommissionAwarenessRequestParameters, CancellationToken)

PUT on /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public Task<TResponse> PutDecommissionAwarenessAsync<TResponse>(string awarenessAttributeName, string awarenessAttributeValue, PutDecommissionAwarenessRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	Awareness attribute name.
string	awarenessAttributeValue	Awareness attribute value.
PutDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutDecommissionAwareness<TResponse>(string, string, PutDecommissionAwarenessRequestParameters)

PUT on /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone

Declaration

public TResponse PutDecommissionAwareness<TResponse>(string awarenessAttributeName, string awarenessAttributeValue, PutDecommissionAwarenessRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	awarenessAttributeName	Awareness attribute name.
string	awarenessAttributeValue	Awareness attribute value.
PutDecommissionAwarenessRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutSettingsAsync<TResponse>(PostData, ClusterPutSettingsRequestParameters, CancellationToken)

PUT on /_cluster/settings

https://opensearch.org/docs/latest/api-reference/cluster-settings/

Declaration

public Task<TResponse> PutSettingsAsync<TResponse>(PostData body, ClusterPutSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).
ClusterPutSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutSettings<TResponse>(PostData, ClusterPutSettingsRequestParameters)

PUT on /_cluster/settings

https://opensearch.org/docs/latest/api-reference/cluster-settings/

Declaration

public TResponse PutSettings<TResponse>(PostData body, ClusterPutSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).
ClusterPutSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutWeightedRoutingAsync<TResponse>(string, PostData, PutWeightedRoutingRequestParameters, CancellationToken)

PUT on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search

Declaration

public Task<TResponse> PutWeightedRoutingAsync<TResponse>(string attribute, PostData body, PutWeightedRoutingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	Awareness attribute name.
PostData	body
PutWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PutWeightedRouting<TResponse>(string, PostData, PutWeightedRoutingRequestParameters)

PUT on /_cluster/routing/awareness/{attribute}/weights

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search

Declaration

public TResponse PutWeightedRouting<TResponse>(string attribute, PostData body, PutWeightedRoutingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	attribute	Awareness attribute name.
PostData	body
PutWeightedRoutingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

RemoteInfoAsync<TResponse>(RemoteInfoRequestParameters, CancellationToken)

GET on /_remote/info

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public Task<TResponse> RemoteInfoAsync<TResponse>(RemoteInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RemoteInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

RemoteInfo<TResponse>(RemoteInfoRequestParameters)

GET on /_remote/info

https://opensearch.org/docs/latest/api-reference/remote-info/

Declaration

public TResponse RemoteInfo<TResponse>(RemoteInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RemoteInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

RerouteAsync<TResponse>(PostData, ClusterRerouteRequestParameters, CancellationToken)

POST on /_cluster/reroute

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> RerouteAsync<TResponse>(PostData body, ClusterRerouteRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The definition of `commands` to perform (`move`, `cancel`, `allocate`).
ClusterRerouteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Reroute<TResponse>(PostData, ClusterRerouteRequestParameters)

POST on /_cluster/reroute

https://opensearch.org/docs/latest

Declaration

public TResponse Reroute<TResponse>(PostData body, ClusterRerouteRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The definition of `commands` to perform (`move`, `cancel`, `allocate`).
ClusterRerouteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StateAsync<TResponse>(ClusterStateRequestParameters, CancellationToken)

GET on /_cluster/state

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StateAsync<TResponse>(ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StateAsync<TResponse>(string, ClusterStateRequestParameters, CancellationToken)

GET on /_cluster/state/{metric}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StateAsync<TResponse>(string metric, ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StateAsync<TResponse>(string, string, ClusterStateRequestParameters, CancellationToken)

GET on /_cluster/state/{metric}/{index}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StateAsync<TResponse>(string metric, string index, ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
string	index	A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

State<TResponse>(ClusterStateRequestParameters)

GET on /_cluster/state

https://opensearch.org/docs/latest

Declaration

public TResponse State<TResponse>(ClusterStateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

State<TResponse>(string, ClusterStateRequestParameters)

GET on /_cluster/state/{metric}

https://opensearch.org/docs/latest

Declaration

public TResponse State<TResponse>(string metric, ClusterStateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

State<TResponse>(string, string, ClusterStateRequestParameters)

GET on /_cluster/state/{metric}/{index}

https://opensearch.org/docs/latest

Declaration

public TResponse State<TResponse>(string metric, string index, ClusterStateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	metric	Limit the information returned to the specified metrics.
string	index	A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices.
ClusterStateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsAsync<TResponse>(ClusterStatsRequestParameters, CancellationToken)

GET on /_cluster/stats

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public Task<TResponse> StatsAsync<TResponse>(ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

StatsAsync<TResponse>(string, ClusterStatsRequestParameters, CancellationToken)

GET on /_cluster/stats/nodes/{node_id}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public Task<TResponse> StatsAsync<TResponse>(string nodeId, ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Stats<TResponse>(ClusterStatsRequestParameters)

GET on /_cluster/stats

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public TResponse Stats<TResponse>(ClusterStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Stats<TResponse>(string, ClusterStatsRequestParameters)

GET on /_cluster/stats/nodes/{node_id}

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

Declaration

public TResponse Stats<TResponse>(string nodeId, ClusterStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.
ClusterStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)