Class UpdateIndexSettingsRequest
Request for UpdateSettings
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class UpdateIndexSettingsRequest : PlainRequestBase<UpdateIndexSettingsRequestParameters>, IUpdateIndexSettingsRequest, IRequest<UpdateIndexSettingsRequestParameters>, IRequest
Constructors
| Edit this page View SourceUpdateIndexSettingsRequest()
/_settings
Declaration
public UpdateIndexSettingsRequest()
UpdateIndexSettingsRequest(Indices)
/{index}/_settings
Declaration
public UpdateIndexSettingsRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Properties
| Edit this page View SourceAllowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have
been specified)
Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ClusterManagerTimeout
Specify timeout for connection to cluster_manager node
Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout
ExpandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type | Description |
---|---|
ExpandWildcards? |
FlatSettings
Return settings in flat format (default: false)
Declaration
public bool? FlatSettings { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreUnavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IndexSettings
Declaration
public IDynamicIndexSettings IndexSettings { get; set; }
Property Value
Type | Description |
---|---|
IDynamicIndexSettings |
MasterTimeout
Specify timeout for connection to master node
Declaration
public Time MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
PreserveExisting
Whether to update existing settings. If set to true
existing settings on an index remain unchanged, the default is false
Declaration
public bool? PreserveExisting { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Self
Declaration
protected IUpdateIndexSettingsRequest Self { get; }
Property Value
Type | Description |
---|---|
IUpdateIndexSettingsRequest |
Timeout
Explicit operation timeout
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |