Class AliasExistsDescriptor
Descriptor for AliasExists
https://opensearch.org/docs/latest/opensearch/rest-api/alias/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AliasExistsDescriptor : RequestDescriptorBase<AliasExistsDescriptor, AliasExistsRequestParameters, IAliasExistsRequest>, IDescriptor, IAliasExistsRequest, IRequest<AliasExistsRequestParameters>, IRequest
Constructors
| Edit this page View SourceAliasExistsDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected AliasExistsDescriptor()
AliasExistsDescriptor(Indices, Names)
/{index}/_alias/{name}
Declaration
public AliasExistsDescriptor(Indices index, Names name)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Names | name | this parameter is required |
AliasExistsDescriptor(Names)
/_alias/{name}
Declaration
public AliasExistsDescriptor(Names name)
Parameters
Type | Name | Description |
---|---|---|
Names | name | this parameter is required |
Methods
| Edit this page View SourceAllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public AliasExistsDescriptor AllIndices()
Returns
Type | Description |
---|---|
AliasExistsDescriptor |
AllowNoIndices(bool?)
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have been specified)
Declaration
public AliasExistsDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | allownoindices |
Returns
Type | Description |
---|---|
AliasExistsDescriptor |
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public AliasExistsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type | Name | Description |
---|---|---|
ExpandWildcards? | expandwildcards |
Returns
Type | Description |
---|---|
AliasExistsDescriptor |
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public AliasExistsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | ignoreunavailable |
Returns
Type | Description |
---|---|
AliasExistsDescriptor |
Index(Indices)
A comma-separated list of index names to filter aliases
Declaration
public AliasExistsDescriptor Index(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index |
Returns
Type | Description |
---|---|
AliasExistsDescriptor |
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public AliasExistsDescriptor Index<TOther>() where TOther : class
Returns
Type | Description |
---|---|
AliasExistsDescriptor |
Type Parameters
Name | Description |
---|---|
TOther |
Local(bool?)
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public AliasExistsDescriptor Local(bool? local = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | local |
Returns
Type | Description |
---|---|
AliasExistsDescriptor |