Class GetAliasRequest

Request for GetAlias

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

Inheritance

object

RequestBase<GetAliasRequestParameters>

PlainRequestBase<GetAliasRequestParameters>

GetAliasRequest

Implements

IGetAliasRequest

IRequest<GetAliasRequestParameters>

IRequest

Inherited Members

PlainRequestBase<GetAliasRequestParameters>.RequestConfiguration

PlainRequestBase<GetAliasRequestParameters>.ErrorTrace

PlainRequestBase<GetAliasRequestParameters>.FilterPath

PlainRequestBase<GetAliasRequestParameters>.Human

PlainRequestBase<GetAliasRequestParameters>.Pretty

PlainRequestBase<GetAliasRequestParameters>.SourceQueryString

RequestBase<GetAliasRequestParameters>.HttpMethod

RequestBase<GetAliasRequestParameters>.RequestState

RequestBase<GetAliasRequestParameters>.ContentType

RequestBase<GetAliasRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<GetAliasRequestParameters>.RequestDefaults(GetAliasRequestParameters)

RequestBase<GetAliasRequestParameters>.Q<TOut>(string)

RequestBase<GetAliasRequestParameters>.Q(string, object)

RequestBase<GetAliasRequestParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class GetAliasRequest : PlainRequestBase<GetAliasRequestParameters>, IGetAliasRequest, IRequest<GetAliasRequestParameters>, IRequest

Constructors

GetAliasRequest()

/_alias

Declaration

public GetAliasRequest()

GetAliasRequest(Indices)

/{index}/_alias

Declaration

public GetAliasRequest(Indices index)

Parameters

Type	Name	Description
Indices	index	Optional, accepts null

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

GetAliasRequest(Names)

/_alias/{name}

Declaration

public GetAliasRequest(Names name)

Parameters

Type	Name	Description
Names	name	Optional, accepts null

Properties

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?

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?

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?

Local

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

Declaration

public bool? Local { get; set; }

Property Value

Type	Description
bool?

Self

Declaration

protected IGetAliasRequest Self { get; }

Property Value

Type	Description
IGetAliasRequest

Implements

IGetAliasRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)