Class PutAliasDescriptor

Descriptor for PutAlias

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

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

Constructors

| Edit this page View Source

PutAliasDescriptor()

/_alias

Declaration
public PutAliasDescriptor()
| Edit this page View Source

PutAliasDescriptor(Indices)

/{index}/_alias

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

Optional, accepts null
| Edit this page View Source

PutAliasDescriptor(Indices, Name)

/{index}/_alias/{name}

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

Optional, accepts null
Name name

Optional, accepts null
| Edit this page View Source

PutAliasDescriptor(Name)

/_alias/{name}

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public PutAliasDescriptor AllIndices()
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public PutAliasDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
PutAliasDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Filter<T>(Func<QueryContainerDescriptor<T>, QueryContainer>)

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 PutAliasDescriptor Filter<T>(Func<QueryContainerDescriptor<T>, QueryContainer> filterSelector) where T : class
Parameters
Type Name Description
Func<QueryContainerDescriptor<T>, QueryContainer> filterSelector
Returns
Type Description
PutAliasDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Index(Indices)

Comma-separated list of data streams or indices to add. Supports wildcards (*). Wildcard patterns that match both data streams and indices return an error.

Declaration
public PutAliasDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

IndexRouting(Routing)

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 PutAliasDescriptor IndexRouting(Routing routing)
Parameters
Type Name Description
Routing routing
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public PutAliasDescriptor Index<TOther>() where TOther : class
Returns
Type Description
PutAliasDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

IsWriteIndex(bool?)

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 PutAliasDescriptor IsWriteIndex(bool? isWriteIndex = true)
Parameters
Type Name Description
bool? isWriteIndex
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the master 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 PutAliasDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

Name(Name)

Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math.

Declaration
public PutAliasDescriptor Name(Name name)
Parameters
Type Name Description
Name name
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

Routing(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 PutAliasDescriptor Routing(Routing routing)
Parameters
Type Name Description
Routing routing
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

SearchRouting(Routing)

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 PutAliasDescriptor SearchRouting(Routing routing)
Parameters
Type Name Description
Routing routing
Returns
Type Description
PutAliasDescriptor
| Edit this page View Source

Timeout(Time)

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

Declaration
public PutAliasDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
PutAliasDescriptor

Implements

Extension Methods