Class AliasExistsRequest
Request for AliasExists
https://opensearch.org/docs/latest
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AliasExistsRequest : PlainRequestBase<AliasExistsRequestParameters>, IAliasExistsRequest, IRequest<AliasExistsRequestParameters>, IRequest
Constructors
| Edit this page View SourceAliasExistsRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected AliasExistsRequest()
AliasExistsRequest(Indices, Names)
/{index}/_alias/{name}
Declaration
public AliasExistsRequest(Indices index, Names name)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Names | name | this parameter is required |
AliasExistsRequest(Names)
/_alias/{name}
Declaration
public AliasExistsRequest(Names name)
Parameters
Type | Name | Description |
---|---|---|
Names | name | this parameter is required |
Properties
| Edit this page View SourceAllowNoIndices
If false
, the request returns an error if any wildcard expression, index alias, or _all
value targets only missing or closed indexes.
This behavior applies even if the request targets other open indexes.
Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ExpandWildcards
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard
expressions match hidden data streams. Supports comma-separated values, such as open,hidden
. Valid values are: all
, open
, closed
,
hidden
, none
.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type | Description |
---|---|
ExpandWildcards? |
IgnoreUnavailable
If false
, requests that include a missing data stream or index in the target indexes or data streams return an error.
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Local
If true
, the request retrieves information from the local node only.
Declaration
public bool? Local { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Self
Declaration
protected IAliasExistsRequest Self { get; }
Property Value
Type | Description |
---|---|
IAliasExistsRequest |