Class PutAliasRequest

A request to put an alias to one or more indices

Inheritance
object
RequestBase<PutAliasRequestParameters>
PlainRequestBase<PutAliasRequestParameters>
PutAliasRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutAliasRequest : PlainRequestBase<PutAliasRequestParameters>, IPutAliasRequest, IRequest<PutAliasRequestParameters>, IRequest

Constructors

| Edit this page View Source

PutAliasRequest()

/_alias

Declaration
public PutAliasRequest()
| Edit this page View Source

PutAliasRequest(Indices)

/{index}/_alias

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

Optional, accepts null
| Edit this page View Source

PutAliasRequest(Indices, Name)

/{index}/_alias/{name}

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

Optional, accepts null
Name name

Optional, accepts null
| Edit this page View Source

PutAliasRequest(Name)

/_alias/{name}

Declaration
public PutAliasRequest(Name name)
Parameters
Type Name Description
Name name

Optional, accepts null

Properties

| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Filter

Provides an easy way to create different "views" of the same index. A filter can be defined using Query DSL and is applied to all Search, Count, Delete By Query and More Like This operations with this alias.

Declaration
public QueryContainer Filter { get; set; }
Property Value
Type Description
QueryContainer
| Edit this page View Source

IndexRouting

Associates routing values with aliases for index operations. This feature can be used together with filtering aliases in order to avoid unnecessary shard operations.

Declaration
public Routing IndexRouting { get; set; }
Property Value
Type Description
Routing
| Edit this page View Source

IsWriteIndex

If an alias points to multiple indices, OpenSearch will reject the write operations unless one is explicitly marked as the write alias using this property.

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

MasterTimeout

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Routing

Associates routing values with aliases for both index and search operations. This feature can be used together with filtering aliases in order to avoid unnecessary shard operations.

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

SearchRouting

Associates routing values with aliases for search operations. This feature can be used together with filtering aliases in order to avoid unnecessary shard operations.

Declaration
public Routing SearchRouting { get; set; }
Property Value
Type Description
Routing
| Edit this page View Source

Self

Declaration
protected IPutAliasRequest Self { get; }
Property Value
Type Description
IPutAliasRequest
| Edit this page View Source

Timeout

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time

Implements

Extension Methods