Class CloseIndexDescriptor

Descriptor for Close

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/

Inheritance
object
RequestBase<CloseIndexRequestParameters>
RequestDescriptorBase<CloseIndexDescriptor, CloseIndexRequestParameters, ICloseIndexRequest>
CloseIndexDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
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)

/{index}/_close

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
Type Description
CloseIndexDescriptor
| Edit this page View Source

AllowNoIndices(bool?)

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

Declaration
public CloseIndexDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
CloseIndexDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public CloseIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CloseIndexDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards(ExpandWildcards?)

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

Declaration
public CloseIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
CloseIndexDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

If false, the request returns an error if it targets a missing or closed index.

Declaration
public CloseIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
CloseIndexDescriptor
| Edit this page View Source

Index(Indices)

Comma-separated list or wildcard expression of index names used to limit the request.

Declaration
public CloseIndexDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
CloseIndexDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public CloseIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Description
CloseIndexDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CloseIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CloseIndexDescriptor
| Edit this page View Source

Timeout(Time)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
public CloseIndexDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
CloseIndexDescriptor
| Edit this page View Source

WaitForActiveShards(string)

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

Declaration
public CloseIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type Name Description
string waitforactiveshards
Returns
Type Description
CloseIndexDescriptor

Implements

Extension Methods