Class UpdateIndexSettingsDescriptor

Descriptor for UpdateSettings

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

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

Constructors

| Edit this page View Source

UpdateIndexSettingsDescriptor()

/_settings

Declaration
public UpdateIndexSettingsDescriptor()
| Edit this page View Source

UpdateIndexSettingsDescriptor(Indices)

/{index}/_settings

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public UpdateIndexSettingsDescriptor AllIndices()
Returns
Type Description
UpdateIndexSettingsDescriptor
| Edit this page View Source

AllowNoIndices(bool?)

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

Declaration
public UpdateIndexSettingsDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
UpdateIndexSettingsDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards(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 UpdateIndexSettingsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
UpdateIndexSettingsDescriptor
| Edit this page View Source

FlatSettings(bool?)

If true, returns settings in flat format.

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

IgnoreUnavailable(bool?)

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

Declaration
public UpdateIndexSettingsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
UpdateIndexSettingsDescriptor
| Edit this page View Source

Index(Indices)

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Declaration
public UpdateIndexSettingsDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
UpdateIndexSettingsDescriptor
| Edit this page View Source

IndexSettings(Func<DynamicIndexSettingsDescriptor, IPromise<IDynamicIndexSettings>>)

Declaration
public UpdateIndexSettingsDescriptor IndexSettings(Func<DynamicIndexSettingsDescriptor, IPromise<IDynamicIndexSettings>> settings)
Parameters
Type Name Description
Func<DynamicIndexSettingsDescriptor, IPromise<IDynamicIndexSettings>> settings
Returns
Type Description
UpdateIndexSettingsDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public UpdateIndexSettingsDescriptor Index<TOther>() where TOther : class
Returns
Type Description
UpdateIndexSettingsDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

MasterTimeout(Time)

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

PreserveExisting(bool?)

If true, existing index settings remain unchanged.

Declaration
public UpdateIndexSettingsDescriptor PreserveExisting(bool? preserveexisting = true)
Parameters
Type Name Description
bool? preserveexisting
Returns
Type Description
UpdateIndexSettingsDescriptor
| 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 UpdateIndexSettingsDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
UpdateIndexSettingsDescriptor

Implements

Extension Methods