Class AliasExistsDescriptor

Descriptor for AliasExists

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<AliasExistsRequestParameters>
RequestDescriptorBase<AliasExistsDescriptor, AliasExistsRequestParameters, IAliasExistsRequest>
AliasExistsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AliasExistsDescriptor : RequestDescriptorBase<AliasExistsDescriptor, AliasExistsRequestParameters, IAliasExistsRequest>, IDescriptor, IAliasExistsRequest, IRequest<AliasExistsRequestParameters>, IRequest

Constructors

| Edit this page View Source

AliasExistsDescriptor()

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

Declaration
protected AliasExistsDescriptor()
| Edit this page View Source

AliasExistsDescriptor(Indices, Names)

/{index}/_alias/{name}

Declaration
public AliasExistsDescriptor(Indices index, Names name)
Parameters
Type Name Description
Indices index

Optional, accepts null
Names name

this parameter is required
| Edit this page View Source

AliasExistsDescriptor(Names)

/_alias/{name}

Declaration
public AliasExistsDescriptor(Names name)
Parameters
Type Name Description
Names name

this parameter is required

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

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

IgnoreUnavailable(bool?)

If false, requests that include a missing data stream or index in the target indexes or data streams return an error.

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

Index(Indices)

Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public AliasExistsDescriptor Index<TOther>() where TOther : class
Returns
Type Description
AliasExistsDescriptor
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 AliasExistsDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
AliasExistsDescriptor

Implements

Extension Methods