Class IndexExistsDescriptor

Descriptor for Exists

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

Inheritance
object
RequestBase<IndexExistsRequestParameters>
RequestDescriptorBase<IndexExistsDescriptor, IndexExistsRequestParameters, IIndexExistsRequest>
IndexExistsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class IndexExistsDescriptor : RequestDescriptorBase<IndexExistsDescriptor, IndexExistsRequestParameters, IIndexExistsRequest>, IDescriptor, IIndexExistsRequest, IRequest<IndexExistsRequestParameters>, IRequest

Constructors

| Edit this page View Source

IndexExistsDescriptor()

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

Declaration
protected IndexExistsDescriptor()
| Edit this page View Source

IndexExistsDescriptor(Indices)

/{index}

Declaration
public IndexExistsDescriptor(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 IndexExistsDescriptor AllIndices()
Returns
Type Description
IndexExistsDescriptor
| 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 IndexExistsDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
IndexExistsDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

FlatSettings(bool?)

If true, returns settings in flat format.

Declaration
public IndexExistsDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
IndexExistsDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

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

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

IncludeDefaults(bool?)

If true, return all default settings in the response.

Declaration
public IndexExistsDescriptor IncludeDefaults(bool? includedefaults = true)
Parameters
Type Name Description
bool? includedefaults
Returns
Type Description
IndexExistsDescriptor
| Edit this page View Source

Index(Indices)

Comma-separated list of data streams, indexes, and aliases. Supports wildcards (*).

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

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

Local(bool?)

If true, the request retrieves information from the local node only.

Declaration
public IndexExistsDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
IndexExistsDescriptor

Implements

Extension Methods