Table of Contents

Class UpdateByQueryRequestParameters

Namespace
Elasticsearch.Net
Assembly
Elasticsearch.Net.dll

Request options for UpdateByQuery

https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
public class UpdateByQueryRequestParameters : RequestParameters<UpdateByQueryRequestParameters>, IRequestParameters
Inheritance
UpdateByQueryRequestParameters
Implements
Inherited Members

Constructors

UpdateByQueryRequestParameters() 

public UpdateByQueryRequestParameters()

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

Conflicts

What to do when the update by query hits version conflicts?

public Conflicts? Conflicts { get; set; }

Property Value

Conflicts?

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

ExpandWildcards

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

public ExpandWildcards? ExpandWildcards { get; set; }

Property Value

ExpandWildcards?

From

Starting offset (default: 0)

public long? From { get; set; }

Property Value

long?

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?

Pipeline

Ingest pipeline to set on index requests made by this action. (default: none)

public string Pipeline { get; set; }

Property Value

string

Preference

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

public string Preference { get; set; }

Property Value

string

QueryOnQueryString

Query in the Lucene query string syntax

public string QueryOnQueryString { get; set; }

Property Value

string

Refresh

Should the effected indexes be refreshed?

public bool? Refresh { get; set; }

Property Value

bool?

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?

RequestsPerSecond

The throttle to set on this request in sub-requests per second. -1 means no throttle.

public long? RequestsPerSecond { get; set; }

Property Value

long?

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

ScrollSize

Size on the scroll request powering the update_by_query

public long? ScrollSize { get; set; }

Property Value

long?

SearchTimeout

Explicit timeout for each search request. Defaults to no timeout.

public TimeSpan SearchTimeout { get; set; }

Property Value

TimeSpan

SearchType

Search operation type

public SearchType? SearchType { get; set; }

Property Value

SearchType?

Size

Number of hits to return (default: 10)

public long? Size { get; set; }

Property Value

long?

Slices

The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.

public long? Slices { get; set; }

Property Value

long?

Sort 

public string[] Sort { get; set; }

Property Value

string[]

SourceEnabled

True or false to return the _source field or not, or a list of fields to return

public bool? SourceEnabled { get; set; }

Property Value

bool?

SourceExclude

A list of fields to exclude from the returned _source field

public string[] SourceExclude { get; set; }

Property Value

string[]

SourceInclude

A list of fields to extract and return from the _source field

public string[] SourceInclude { get; set; }

Property Value

string[]

Stats

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

public string[] Stats { get; set; }

Property Value

string[]

TerminateAfter

The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.

public long? TerminateAfter { get; set; }

Property Value

long?

Timeout

Time each individual bulk request should wait for shards that are unavailable.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

Version

Specify whether to return document version as part of a hit

public bool? Version { get; set; }

Property Value

bool?

VersionType

Should the document increment the version number (internal) on hit or not (reindex)

public bool? VersionType { get; set; }

Property Value

bool?

WaitForActiveShards

Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

public string WaitForActiveShards { get; set; }

Property Value

string

WaitForCompletion

Should the request should block until the update by query operation is complete.

public bool? WaitForCompletion { get; set; }

Property Value

bool?