Class ClusterPutSettingsDescriptor

Descriptor for PutSettings

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

Inheritance
object
RequestBase<ClusterPutSettingsRequestParameters>
RequestDescriptorBase<ClusterPutSettingsDescriptor, ClusterPutSettingsRequestParameters, IClusterPutSettingsRequest>
ClusterPutSettingsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterPutSettingsDescriptor : RequestDescriptorBase<ClusterPutSettingsDescriptor, ClusterPutSettingsRequestParameters, IClusterPutSettingsRequest>, IDescriptor, IClusterPutSettingsRequest, IRequest<ClusterPutSettingsRequestParameters>, IRequest

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 ClusterPutSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
ClusterPutSettingsDescriptor
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 ClusterPutSettingsDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
ClusterPutSettingsDescriptor
| 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 ClusterPutSettingsDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
ClusterPutSettingsDescriptor
| Edit this page View Source

Persistent(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

Declaration
public ClusterPutSettingsDescriptor Persistent(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector)
Parameters
Type Name Description
Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector
Returns
Type Description
ClusterPutSettingsDescriptor
| Edit this page View Source

Timeout(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
public ClusterPutSettingsDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
ClusterPutSettingsDescriptor
| Edit this page View Source

Transient(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

Declaration
public ClusterPutSettingsDescriptor Transient(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector)
Parameters
Type Name Description
Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector
Returns
Type Description
ClusterPutSettingsDescriptor

Implements

Extension Methods