Class UpdateIndexSettingsRequest

Request for UpdateSettings

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/

Inheritance
object
RequestBase<UpdateIndexSettingsRequestParameters>
PlainRequestBase<UpdateIndexSettingsRequestParameters>
UpdateIndexSettingsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class UpdateIndexSettingsRequest : PlainRequestBase<UpdateIndexSettingsRequestParameters>, IUpdateIndexSettingsRequest, IRequest<UpdateIndexSettingsRequestParameters>, IRequest

Constructors

| Edit this page View Source

UpdateIndexSettingsRequest()

/_settings

Declaration
public UpdateIndexSettingsRequest()
| Edit this page View Source

UpdateIndexSettingsRequest(Indices)

/{index}/_settings

Declaration
public UpdateIndexSettingsRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Properties

| Edit this page View Source

AllowNoIndices

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| 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

ExpandWildcards

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| 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

IgnoreUnavailable

Whether specified concrete indexes should be ignored when unavailable (missing or closed).

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

IndexSettings

Declaration
public IDynamicIndexSettings IndexSettings { get; set; }
Property Value
Type Description
IDynamicIndexSettings
| 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

PreserveExisting

If true, existing index settings remain unchanged.

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

Self

Declaration
protected IUpdateIndexSettingsRequest Self { get; }
Property Value
Type Description
IUpdateIndexSettingsRequest
| 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