Class GetAliasDescriptor

Descriptor for GetAlias

https://opensearch.org/docs/latest/im-plugin/index-alias/

Inheritance
object
RequestBase<GetAliasRequestParameters>
RequestDescriptorBase<GetAliasDescriptor, GetAliasRequestParameters, IGetAliasRequest>
GetAliasDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetAliasDescriptor : RequestDescriptorBase<GetAliasDescriptor, GetAliasRequestParameters, IGetAliasRequest>, IDescriptor, IGetAliasRequest, IRequest<GetAliasRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetAliasDescriptor()

/_alias

Declaration
public GetAliasDescriptor()
| Edit this page View Source

GetAliasDescriptor(Indices)

/{index}/_alias

Declaration
public GetAliasDescriptor(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null
| Edit this page View Source

GetAliasDescriptor(Indices, Names)

/{index}/_alias/{name}

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

Optional, accepts null
Names name

Optional, accepts null
| Edit this page View Source

GetAliasDescriptor(Names)

/_alias/{name}

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

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

IgnoreUnavailable(bool?)

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

Declaration
public GetAliasDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
GetAliasDescriptor
| 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 GetAliasDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
GetAliasDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

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

Name(Names)

Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

Declaration
public GetAliasDescriptor Name(Names name)
Parameters
Type Name Description
Names name
Returns
Type Description
GetAliasDescriptor

Implements

Extension Methods