Class CloseIndexRequest
Request for Close
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CloseIndexRequest : PlainRequestBase<CloseIndexRequestParameters>, ICloseIndexRequest, IRequest<CloseIndexRequestParameters>, IRequest
Constructors
| Edit this page View SourceCloseIndexRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CloseIndexRequest()
CloseIndexRequest(Indices)
/{index}/_close
Declaration
public CloseIndexRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | this parameter is required |
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? |
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 Time MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
Self
Declaration
protected ICloseIndexRequest Self { get; }
Property Value
Type | Description |
---|---|
ICloseIndexRequest |
Timeout
Explicit operation timeout
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
WaitForActiveShards
Sets the number of active shards to wait for before the operation returns.
Declaration
public string WaitForActiveShards { get; set; }
Property Value
Type | Description |
---|---|
string |