Class ClusterGetSettingsDescriptor

Descriptor for GetSettings

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

Inheritance
object
RequestBase<ClusterGetSettingsRequestParameters>
RequestDescriptorBase<ClusterGetSettingsDescriptor, ClusterGetSettingsRequestParameters, IClusterGetSettingsRequest>
ClusterGetSettingsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterGetSettingsDescriptor : RequestDescriptorBase<ClusterGetSettingsDescriptor, ClusterGetSettingsRequestParameters, IClusterGetSettingsRequest>, IDescriptor, IClusterGetSettingsRequest, IRequest<ClusterGetSettingsRequestParameters>, IRequest

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public ClusterGetSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
ClusterGetSettingsDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

FlatSettings(bool?)

If true, returns settings in flat format.

Declaration
public ClusterGetSettingsDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
ClusterGetSettingsDescriptor
| Edit this page View Source

IncludeDefaults(bool?)

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

Declaration
public ClusterGetSettingsDescriptor IncludeDefaults(bool? includedefaults = true)
Parameters
Type Name Description
bool? includedefaults
Returns
Type Description
ClusterGetSettingsDescriptor
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the cluster-manager 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 ClusterGetSettingsDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
ClusterGetSettingsDescriptor
| Edit this page View Source

Timeout(Time)

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

Declaration
public ClusterGetSettingsDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
ClusterGetSettingsDescriptor

Implements

Extension Methods