Class GetIndexSettingsDescriptor
Descriptor for GetSettings
Inheritance
GetIndexSettingsDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class GetIndexSettingsDescriptor : RequestDescriptorBase<GetIndexSettingsDescriptor, GetIndexSettingsRequestParameters, IGetIndexSettingsRequest>, IDescriptor, IGetIndexSettingsRequest, IRequest<GetIndexSettingsRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
GetIndexSettingsDescriptor()
Declaration
public GetIndexSettingsDescriptor()
|
Edit this page
View Source
GetIndexSettingsDescriptor(Indices)
Declaration
public GetIndexSettingsDescriptor(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
Optional, accepts null
|
|
Edit this page
View Source
GetIndexSettingsDescriptor(Indices, Names)
/{index}/_settings/{name}
Declaration
public GetIndexSettingsDescriptor(Indices index, Names name)
Parameters
Type |
Name |
Description |
Indices |
index |
Optional, accepts null
|
Names |
name |
Optional, accepts null
|
|
Edit this page
View Source
GetIndexSettingsDescriptor(Names)
Declaration
public GetIndexSettingsDescriptor(Names name)
Parameters
Type |
Name |
Description |
Names |
name |
Optional, accepts null
|
Methods
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public GetIndexSettingsDescriptor 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 GetIndexSettingsDescriptor 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 GetIndexSettingsDescriptor 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 GetIndexSettingsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
FlatSettings(bool?)
Return settings in flat format (default: false)
Declaration
public GetIndexSettingsDescriptor 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 GetIndexSettingsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
IncludeDefaults(bool?)
Whether to return all default setting for each of the indices.
Declaration
public GetIndexSettingsDescriptor IncludeDefaults(bool? includedefaults = true)
Parameters
Type |
Name |
Description |
bool? |
includedefaults |
|
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 GetIndexSettingsDescriptor Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public GetIndexSettingsDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Local(bool?)
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public GetIndexSettingsDescriptor Local(bool? local = true)
Parameters
Type |
Name |
Description |
bool? |
local |
|
Returns
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public GetIndexSettingsDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Name(Names)
The name of the settings that should be included
Declaration
public GetIndexSettingsDescriptor Name(Names name)
Parameters
Type |
Name |
Description |
Names |
name |
|
Returns
Implements
Extension Methods