Table of Contents

Class SearchRequestParameters

Namespace
Elasticsearch.Net
Assembly
Elasticsearch.Net.dll

Request options for Search

http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html
public class SearchRequestParameters : RequestParameters<SearchRequestParameters>, IRequestParameters
Inheritance
SearchRequestParameters
Implements
Inherited Members

Constructors

SearchRequestParameters() 

public SearchRequestParameters()

Properties

AllowNoIndices

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

public bool? AllowNoIndices { get; set; }

Property Value

bool?

AnalyzeWildcard

Specify whether wildcard and prefix queries should be analyzed (default: false)

public bool? AnalyzeWildcard { get; set; }

Property Value

bool?

Analyzer

The analyzer to use for the query string

public string Analyzer { get; set; }

Property Value

string

BatchedReduceSize

The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.

public long? BatchedReduceSize { get; set; }

Property Value

long?

DefaultHttpMethod 

public override HttpMethod DefaultHttpMethod { get; }

Property Value

HttpMethod

DefaultOperator

The default operator for query string query (AND or OR)

public DefaultOperator? DefaultOperator { get; set; }

Property Value

DefaultOperator?

Df

The field to use as default where no field prefix is given in the query string

public string Df { get; set; }

Property Value

string

DocValueFields

A comma-separated list of fields to return as the docvalue representation of a field for each hit

public string[] DocValueFields { get; set; }

Property Value

string[]

ExpandWildcards

Whether to expand wildcard expression to concrete indices that are open, closed or both.

public ExpandWildcards? ExpandWildcards { get; set; }

Property Value

ExpandWildcards?

IgnoreUnavailable

Whether specified concrete indices should be ignored when unavailable (missing or closed)

public bool? IgnoreUnavailable { get; set; }

Property Value

bool?

Lenient

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

public bool? Lenient { get; set; }

Property Value

bool?

MaxConcurrentShardRequests

The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests

public long? MaxConcurrentShardRequests { get; set; }

Property Value

long?

PreFilterShardSize

A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.

public long? PreFilterShardSize { get; set; }

Property Value

long?

Preference

Specify the node or shard the operation should be performed on (default: random)

public string Preference { get; set; }

Property Value

string

RequestCache

Specify if request cache should be used for this request or not, defaults to index level setting

public bool? RequestCache { get; set; }

Property Value

bool?

Routing

A comma-separated list of specific routing values

public string[] Routing { get; set; }

Property Value

string[]

Scroll

Specify how long a consistent view of the index should be maintained for scrolled search

public TimeSpan Scroll { get; set; }

Property Value

TimeSpan

SearchType

Search operation type

public SearchType? SearchType { get; set; }

Property Value

SearchType?

Stats

Specific 'tag' of the request for logging and statistical purposes

public string[] Stats { get; set; }

Property Value

string[]

StoredFields

A comma-separated list of stored fields to return as part of a hit

public string[] StoredFields { get; set; }

Property Value

string[]

SuggestField

Specify which field to use for suggestions

public string SuggestField { get; set; }

Property Value

string

SuggestMode

Specify suggest mode

public SuggestMode? SuggestMode { get; set; }

Property Value

SuggestMode?

SuggestSize

How many suggestions to return in response

public long? SuggestSize { get; set; }

Property Value

long?

SuggestText

The source text for which the suggestions should be returned

public string SuggestText { get; set; }

Property Value

string

TrackTotalHits

Indicate if the number of documents that match the query should be tracked

public bool? TrackTotalHits { get; set; }

Property Value

bool?

TypedKeys

Specify whether aggregation and suggester names should be prefixed by their respective types in the response

public bool? TypedKeys { get; set; }

Property Value

bool?