Class UpdateByQueryRequestParameters

Request options for UpdateByQuery

https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/

Inheritance

object

RequestParameters<UpdateByQueryRequestParameters>

UpdateByQueryRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<UpdateByQueryRequestParameters>.CustomResponseBuilder

RequestParameters<UpdateByQueryRequestParameters>.QueryString

RequestParameters<UpdateByQueryRequestParameters>.RequestConfiguration

RequestParameters<UpdateByQueryRequestParameters>.ContainsQueryString(string)

RequestParameters<UpdateByQueryRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<UpdateByQueryRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<UpdateByQueryRequestParameters>.SetQueryString(string, object)

RequestParameters<UpdateByQueryRequestParameters>.Q<TOut>(string)

RequestParameters<UpdateByQueryRequestParameters>.Q(string, object)

RequestParameters<UpdateByQueryRequestParameters>.SetAcceptHeader(string)

RequestParameters<UpdateByQueryRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class UpdateByQueryRequestParameters : RequestParameters<UpdateByQueryRequestParameters>, IRequestParameters

Properties

AllowNoIndices

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. 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?

AnalyzeWildcard

If true, wildcard and prefix queries are analyzed.

Declaration

public bool? AnalyzeWildcard { get; set; }

Property Value

Type	Description
bool?

Analyzer

Analyzer to use for the query string.

Declaration

public string Analyzer { get; set; }

Property Value

Type	Description
string

Conflicts

What to do if update by query hits version conflicts: abort or proceed.

Declaration

public Conflicts? Conflicts { get; set; }

Property Value

Type	Description
Conflicts?

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<UpdateByQueryRequestParameters>.DefaultHttpMethod

DefaultOperator

The default operator for query string query: AND or OR.

Declaration

public DefaultOperator? DefaultOperator { get; set; }

Property Value

Type	Description
DefaultOperator?

Df

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

Declaration

public string Df { get; set; }

Property Value

Type	Description
string

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?

From

Starting offset.

Declaration

public long? From { get; set; }

Property Value

Type	Description
long?

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?

Lenient

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

Declaration

public bool? Lenient { get; set; }

Property Value

Type	Description
bool?

Pipeline

ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.

Declaration

public string Pipeline { get; set; }

Property Value

Type	Description
string

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

QueryOnQueryString

Query in the Lucene query string syntax.

Declaration

public string QueryOnQueryString { get; set; }

Property Value

Type	Description
string

Refresh

If true, OpenSearch refreshes affected shards to make the operation visible to search.

Declaration

public bool? Refresh { get; set; }

Property Value

Type	Description
bool?

RequestCache

If true, the request cache is used for this request.

Declaration

public bool? RequestCache { get; set; }

Property Value

Type	Description
bool?

RequestsPerSecond

The throttle for this request in sub-requests per second.

Declaration

public long? RequestsPerSecond { get; set; }

Property Value

Type	Description
long?

Routing

Custom value used to route operations to a specific shard.

Declaration

public string[] Routing { get; set; }

Property Value

Type	Description
string[]

Scroll

Period to retain the search context for scrolling.

Declaration

public TimeSpan Scroll { get; set; }

Property Value

Type	Description
TimeSpan

ScrollSize

Size of the scroll request that powers the operation.

Declaration

public long? ScrollSize { get; set; }

Property Value

Type	Description
long?

SearchTimeout

Explicit timeout for each search request.

Declaration

public TimeSpan SearchTimeout { get; set; }

Property Value

Type	Description
TimeSpan

SearchType

The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch.

Declaration

public SearchType? SearchType { get; set; }

Property Value

Type	Description
SearchType?

Size

Deprecated, please use max_docs instead.

Declaration

public long? Size { get; set; }

Property Value

Type	Description
long?

Sort

A comma-separated list of <field>:<direction> pairs.

Declaration

public string[] Sort { get; set; }

Property Value

Type	Description
string[]

SourceEnabled

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

Declaration

public bool? SourceEnabled { get; set; }

Property Value

Type	Description
bool?

SourceExcludes

List of fields to exclude from the returned _source field.

Declaration

public string[] SourceExcludes { get; set; }

Property Value

Type	Description
string[]

SourceIncludes

List of fields to extract and return from the _source field.

Declaration

public string[] SourceIncludes { get; set; }

Property Value

Type	Description
string[]

Stats

Specific tag of the request for logging and statistical purposes.

Declaration

public string[] Stats { get; set; }

Property Value

Type	Description
string[]

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<UpdateByQueryRequestParameters>.SupportsBody

TerminateAfter

Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.

Declaration

public long? TerminateAfter { get; set; }

Property Value

Type	Description
long?

Timeout

Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

Version

If true, returns the document version as part of a hit.

Declaration

public bool? Version { get; set; }

Property Value

Type	Description
bool?

WaitForActiveShards

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

Declaration

public string WaitForActiveShards { get; set; }

Property Value

Type	Description
string

WaitForCompletion

If true, the request blocks until the operation is complete.

Declaration

public bool? WaitForCompletion { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)