Class PutAliasRequest
A request to put an alias to one or more indices
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutAliasRequest : PlainRequestBase<PutAliasRequestParameters>, IPutAliasRequest, IRequest<PutAliasRequestParameters>, IRequest
Constructors
| Edit this page View SourcePutAliasRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected PutAliasRequest()
PutAliasRequest(Indices, Name)
/{index}/_alias/{name}
Declaration
public PutAliasRequest(Indices index, Name name)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | this parameter is required |
Name | name | this parameter is required |
Properties
| Edit this page View SourceClusterManagerTimeout
Specify timeout for connection to cluster_manager node
Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Introduced in OpenSearch 2.0 instead of MasterTimeout
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 |
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 |
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? |
MasterTimeout
Specify timeout for connection to master node
Declaration
public Time MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Deprecated as of OpenSearch 2.0, use ClusterManagerTimeout instead
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 |
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 |
Self
Declaration
protected IPutAliasRequest Self { get; }
Property Value
Type | Description |
---|---|
IPutAliasRequest |
Timeout
Explicit timestamp for the document
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |