Class ClusterGetSettingsRequestParameters

Request options for GetSettings

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

Inheritance

object

RequestParameters<ClusterGetSettingsRequestParameters>

ClusterGetSettingsRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<ClusterGetSettingsRequestParameters>.CustomResponseBuilder

RequestParameters<ClusterGetSettingsRequestParameters>.QueryString

RequestParameters<ClusterGetSettingsRequestParameters>.RequestConfiguration

RequestParameters<ClusterGetSettingsRequestParameters>.ContainsQueryString(string)

RequestParameters<ClusterGetSettingsRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<ClusterGetSettingsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<ClusterGetSettingsRequestParameters>.SetQueryString(string, object)

RequestParameters<ClusterGetSettingsRequestParameters>.Q<TOut>(string)

RequestParameters<ClusterGetSettingsRequestParameters>.Q(string, object)

RequestParameters<ClusterGetSettingsRequestParameters>.SetAcceptHeader(string)

RequestParameters<ClusterGetSettingsRequestParameters>.AcceptHeaderFromFormat(string)

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 ClusterGetSettingsRequestParameters : RequestParameters<ClusterGetSettingsRequestParameters>, IRequestParameters

Properties

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 TimeSpan ClusterManagerTimeout { get; set; }

Property Value

Type	Description
TimeSpan

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<ClusterGetSettingsRequestParameters>.DefaultHttpMethod

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?

IncludeDefaults

When true, returns default cluster settings from the local node.

Declaration

public bool? IncludeDefaults { get; set; }

Property Value

Type	Description
bool?

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 TimeSpan MasterTimeout { get; set; }

Property Value

Type	Description
TimeSpan

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<ClusterGetSettingsRequestParameters>.SupportsBody

Timeout

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

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)