Class UpdateIndexSettingsDescriptor
Descriptor for UpdateSettings
Inheritance
UpdateIndexSettingsDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class UpdateIndexSettingsDescriptor : RequestDescriptorBase<UpdateIndexSettingsDescriptor, UpdateIndexSettingsRequestParameters, IUpdateIndexSettingsRequest>, IDescriptor, IUpdateIndexSettingsRequest, IRequest<UpdateIndexSettingsRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
UpdateIndexSettingsDescriptor()
Declaration
public UpdateIndexSettingsDescriptor()
|
Edit this page
View Source
UpdateIndexSettingsDescriptor(Indices)
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
|
Edit this page
View Source
AllowNoIndices(bool?)
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 UpdateIndexSettingsDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public UpdateIndexSettingsDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public UpdateIndexSettingsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
FlatSettings(bool?)
Return settings in flat format (default: false)
Declaration
public UpdateIndexSettingsDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type |
Name |
Description |
bool? |
flatsettings |
|
Returns
|
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
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names; use the special string _all
or Indices.All to perform the operation on all indices
Declaration
public UpdateIndexSettingsDescriptor Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
Edit this page
View Source
IndexSettings(Func<DynamicIndexSettingsDescriptor, IPromise<IDynamicIndexSettings>>)
Declaration
public UpdateIndexSettingsDescriptor IndexSettings(Func<DynamicIndexSettingsDescriptor, IPromise<IDynamicIndexSettings>> settings)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public UpdateIndexSettingsDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public UpdateIndexSettingsDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
PreserveExisting(bool?)
Whether to update existing settings. If set to true
existing settings on an index remain unchanged, the default is false
Declaration
public UpdateIndexSettingsDescriptor PreserveExisting(bool? preserveexisting = true)
Parameters
Type |
Name |
Description |
bool? |
preserveexisting |
|
Returns
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public UpdateIndexSettingsDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
Implements
Extension Methods