Class CloseIndexDescriptor
Descriptor for Close
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
Inheritance
CloseIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class CloseIndexDescriptor : RequestDescriptorBase<CloseIndexDescriptor, CloseIndexRequestParameters, ICloseIndexRequest>, IDescriptor, ICloseIndexRequest, IRequest<CloseIndexRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
CloseIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CloseIndexDescriptor()
|
Edit this page
View Source
CloseIndexDescriptor(Indices)
Declaration
public CloseIndexDescriptor(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
this parameter is required
|
Methods
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public CloseIndexDescriptor 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 CloseIndexDescriptor 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 CloseIndexDescriptor 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 CloseIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public CloseIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma separated list of indices to close
Declaration
public CloseIndexDescriptor 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 CloseIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public CloseIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public CloseIndexDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
Sets the number of active shards to wait for before the operation returns.
Declaration
public CloseIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
Implements
Extension Methods