Class ClusterGetSettingsRequest

Request for GetSettings

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

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

Properties

| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

FlatSettings

If true, returns settings in flat format.

Declaration
public bool? FlatSettings { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IncludeDefaults

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

Declaration
public bool? IncludeDefaults { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MasterTimeout

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 Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected IClusterGetSettingsRequest Self { get; }
Property Value
Type Description
IClusterGetSettingsRequest
| Edit this page View Source

Timeout

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

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time

Implements

Extension Methods