Class SearchShardsRequest
Request for SearchShards
https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SearchShardsRequest : PlainRequestBase<SearchShardsRequestParameters>, ISearchShardsRequest, IRequest<SearchShardsRequestParameters>, IRequest
Constructors
| Edit this page View SourceSearchShardsRequest()
/_search_shards
Declaration
public SearchShardsRequest()
SearchShardsRequest(Indices)
/{index}/_search_shards
Declaration
public SearchShardsRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Properties
| Edit this page View SourceAllowNoIndices
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 bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ExpandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type | Description |
---|---|
ExpandWildcards? |
IgnoreUnavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Local
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public bool? Local { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Preference
Specify the node or shard the operation should be performed on (default: random)
Declaration
public string Preference { get; set; }
Property Value
Type | Description |
---|---|
string |
Routing
A document is routed to a particular shard in an index using the following formula
shard_num = hash(_routing) % num_primary_shards
OpenSearch will use the document id if not provided.
For requests that are constructed from/for a document OSC will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings
Declaration
public Routing Routing { get; set; }
Property Value
Type | Description |
---|---|
Routing |
Self
Declaration
protected ISearchShardsRequest Self { get; }
Property Value
Type | Description |
---|---|
ISearchShardsRequest |