Class CloseIndexRequestParameters
Request options for Close
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.IndicesApi
Assembly: OpenSearch.Net.dll
Syntax
public class CloseIndexRequestParameters : RequestParameters<CloseIndexRequestParameters>, IRequestParameters
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 TimeSpan ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| Edit this page View SourceExpandWildcards
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? |
IgnoreUnavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MasterTimeout
Specify timeout for connection to master node
Declaration
public TimeSpan MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
| Edit this page View SourceTimeout
Explicit operation timeout
Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
WaitForActiveShards
Sets the number of active shards to wait for before the operation returns. Set to index-setting
to wait according to the index setting
index.write.wait_for_active_shards
, or all
to wait for all shards, or an integer. Defaults to 0
.
Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type | Description |
---|---|
string |