Class GetAliasDescriptor
Descriptor for GetAlias
https://opensearch.org/docs/latest/opensearch/rest-api/alias/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetAliasDescriptor : RequestDescriptorBase<GetAliasDescriptor, GetAliasRequestParameters, IGetAliasRequest>, IDescriptor, IGetAliasRequest, IRequest<GetAliasRequestParameters>, IRequest
Constructors
| Edit this page View SourceGetAliasDescriptor()
/_alias
Declaration
public GetAliasDescriptor()
GetAliasDescriptor(Indices)
/{index}/_alias
Declaration
public GetAliasDescriptor(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
GetAliasDescriptor(Indices, Names)
/{index}/_alias/{name}
Declaration
public GetAliasDescriptor(Indices index, Names name)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Names | name | Optional, accepts null |
GetAliasDescriptor(Names)
/_alias/{name}
Declaration
public GetAliasDescriptor(Names name)
Parameters
Type | Name | Description |
---|---|---|
Names | name | Optional, accepts null |
Methods
| Edit this page View SourceAllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public GetAliasDescriptor AllIndices()
Returns
Type | Description |
---|---|
GetAliasDescriptor |
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 GetAliasDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | allownoindices |
Returns
Type | Description |
---|---|
GetAliasDescriptor |
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public GetAliasDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type | Name | Description |
---|---|---|
ExpandWildcards? | expandwildcards |
Returns
Type | Description |
---|---|
GetAliasDescriptor |
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public GetAliasDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | ignoreunavailable |
Returns
Type | Description |
---|---|
GetAliasDescriptor |
Index(Indices)
A comma-separated list of index names to filter aliases
Declaration
public GetAliasDescriptor Index(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index |
Returns
Type | Description |
---|---|
GetAliasDescriptor |
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public GetAliasDescriptor Index<TOther>() where TOther : class
Returns
Type | Description |
---|---|
GetAliasDescriptor |
Type Parameters
Name | Description |
---|---|
TOther |
Local(bool?)
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public GetAliasDescriptor Local(bool? local = true)
Parameters
Type | Name | Description |
---|---|---|
bool? | local |
Returns
Type | Description |
---|---|
GetAliasDescriptor |
Name(Names)
A comma-separated list of alias names to return
Declaration
public GetAliasDescriptor Name(Names name)
Parameters
Type | Name | Description |
---|---|---|
Names | name |
Returns
Type | Description |
---|---|
GetAliasDescriptor |