Class GetIndexRequest
Request for Get
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/get-index/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetIndexRequest : PlainRequestBase<GetIndexRequestParameters>, IGetIndexRequest, IRequest<GetIndexRequestParameters>, IRequest
Constructors
| Edit this page View SourceGetIndexRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected GetIndexRequest()
GetIndexRequest(Indices)
/{index}
Declaration
public GetIndexRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | this parameter is required |
Properties
| Edit this page View SourceAllowNoIndices
Ignore if a wildcard expression resolves to no concrete indices (default: false)
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 wildcard expressions should get expanded to open or closed indices (default: open)
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
Ignore unavailable indexes (default: false)
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? |
IncludeTypeName
Whether to add the type name to the response (default: false)
Declaration
public bool? IncludeTypeName { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Remarks
Deprecated as of OpenSearch 2.0
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 IGetIndexRequest Self { get; }
Property Value
Type | Description |
---|---|
IGetIndexRequest |