Class GetAliasRequest

Request for GetAlias

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

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

Constructors

| Edit this page View Source

GetAliasRequest()

/_alias

Declaration
public GetAliasRequest()
| Edit this page View Source

GetAliasRequest(Indices)

/{index}/_alias

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

Optional, accepts null
| Edit this page View Source

GetAliasRequest(Indices, Names)

/{index}/_alias/{name}

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

Optional, accepts null
Names name

Optional, accepts null
| Edit this page View Source

GetAliasRequest(Names)

/_alias/{name}

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

Optional, accepts null

Properties

| Edit this page View Source

AllowNoIndices

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 bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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 ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

IgnoreUnavailable

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

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Local

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

Declaration
public bool? Local { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Self

Declaration
protected IGetAliasRequest Self { get; }
Property Value
Type Description
IGetAliasRequest

Implements

Extension Methods