Class GetIndexSettingsRequest
Request for GetSettings
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetIndexSettingsRequest : PlainRequestBase<GetIndexSettingsRequestParameters>, IGetIndexSettingsRequest, IRequest<GetIndexSettingsRequestParameters>, IRequest
Constructors
| Edit this page View SourceGetIndexSettingsRequest()
/_settings
Declaration
public GetIndexSettingsRequest()
GetIndexSettingsRequest(Indices)
/{index}/_settings
Declaration
public GetIndexSettingsRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
GetIndexSettingsRequest(Indices, Names)
/{index}/_settings/{name}
Declaration
public GetIndexSettingsRequest(Indices index, Names name)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Names | name | Optional, accepts null |
GetIndexSettingsRequest(Names)
/_settings/{name}
Declaration
public GetIndexSettingsRequest(Names name)
Parameters
Type | Name | Description |
---|---|---|
Names | name | 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? |
IncludeDefaults
Whether to return all default setting for each of the indices.
Declaration
public bool? IncludeDefaults { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Local
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public bool? Local { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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
Self
Declaration
protected IGetIndexSettingsRequest Self { get; }
Property Value
Type | Description |
---|---|
IGetIndexSettingsRequest |