Class PutAliasDescriptor
Descriptor for PutAlias
https://opensearch.org/docs/latest/opensearch/rest-api/alias/
Inheritance
PutAliasDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class PutAliasDescriptor : RequestDescriptorBase<PutAliasDescriptor, PutAliasRequestParameters, IPutAliasRequest>, IDescriptor, IPutAliasRequest, IRequest<PutAliasRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
PutAliasDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected PutAliasDescriptor()
|
Edit this page
View Source
PutAliasDescriptor(Indices, Name)
Declaration
public PutAliasDescriptor(Indices index, Name name)
Parameters
Type |
Name |
Description |
Indices |
index |
this parameter is required
|
Name |
name |
this parameter is required
|
Methods
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public PutAliasDescriptor AllIndices()
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public PutAliasDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
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
Returns
Type Parameters
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names the alias should point to (supports wildcards); use _all
to perform the operation on all indices.
Declaration
public PutAliasDescriptor Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
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
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public PutAliasDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
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
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public PutAliasDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
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
|
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
|
Edit this page
View Source
Timeout(Time)
Explicit timestamp for the document
Declaration
public PutAliasDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
Implements
Extension Methods