Class OpenIndexDescriptor

Descriptor for Open

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

Inheritance
object
RequestBase<OpenIndexRequestParameters>
RequestDescriptorBase<OpenIndexDescriptor, OpenIndexRequestParameters, IOpenIndexRequest>
OpenIndexDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class OpenIndexDescriptor : RequestDescriptorBase<OpenIndexDescriptor, OpenIndexRequestParameters, IOpenIndexRequest>, IDescriptor, IOpenIndexRequest, IRequest<OpenIndexRequestParameters>, IRequest

Constructors

| Edit this page View Source

OpenIndexDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected OpenIndexDescriptor()
| Edit this page View Source

OpenIndexDescriptor(Indices)

/{index}/_open

Declaration
public OpenIndexDescriptor(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 OpenIndexDescriptor AllIndices()
Returns
Type Description
OpenIndexDescriptor
| 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 indices. This behavior applies even if the request targets other open indices.

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

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public OpenIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
OpenIndexDescriptor
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 OpenIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
OpenIndexDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

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

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

Index(Indices)

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indices you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the opensearch.yml file or using the cluster update settings API.

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

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

MasterTimeout(Time)

Period to wait for a connection to the master 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 OpenIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
OpenIndexDescriptor
| Edit this page View Source

TaskExecutionTimeout(Time)

Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

Declaration
public OpenIndexDescriptor TaskExecutionTimeout(Time taskexecutiontimeout)
Parameters
Type Name Description
Time taskexecutiontimeout
Returns
Type Description
OpenIndexDescriptor
| 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 OpenIndexDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
OpenIndexDescriptor
| 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 OpenIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type Name Description
string waitforactiveshards
Returns
Type Description
OpenIndexDescriptor
| Edit this page View Source

WaitForCompletion(bool?)

Should this request wait until the operation has completed before returning.

Declaration
public OpenIndexDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type Name Description
bool? waitforcompletion
Returns
Type Description
OpenIndexDescriptor
Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

Implements

Extension Methods