Class SearchShardsRequest

Request for SearchShards

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<SearchShardsRequestParameters>
PlainRequestBase<SearchShardsRequestParameters>
SearchShardsRequest
SearchShardsRequest<TDocument>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SearchShardsRequest : PlainRequestBase<SearchShardsRequestParameters>, ISearchShardsRequest, IRequest<SearchShardsRequestParameters>, IRequest

Constructors

| Edit this page View Source

SearchShardsRequest()

/_search_shards

Declaration
public SearchShardsRequest()
| Edit this page View Source

SearchShardsRequest(Indices)

/{index}/_search_shards

Declaration
public SearchShardsRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Properties

| Edit this page View Source

AllowNoIndices

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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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?
| Edit this page View Source

IgnoreUnavailable

If false, the request returns an error if it targets a missing or closed index.

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Local

If true, the request retrieves information from the local node only.

Declaration
public bool? Local { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Preference

Specifies the node or shard the operation should be performed on. Random by default.

Declaration
public string Preference { get; set; }
Property Value
Type Description
string
| Edit this page View Source

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 OpenSearch.Client 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
| Edit this page View Source

Self

Declaration
protected ISearchShardsRequest Self { get; }
Property Value
Type Description
ISearchShardsRequest

Implements

Extension Methods