Package org.opensearch.index.reindex

Class RestUpdateByQueryAction

java.lang.Object

org.opensearch.rest.BaseRestHandler

org.opensearch.index.reindex.AbstractBaseReindexRestHandler<UpdateByQueryRequest,UpdateByQueryAction>

org.opensearch.index.reindex.AbstractBulkByQueryRestHandler<UpdateByQueryRequest,UpdateByQueryAction>

org.opensearch.index.reindex.RestUpdateByQueryAction

All Implemented Interfaces:

RestHandler

public class RestUpdateByQueryAction
extends AbstractBulkByQueryRestHandler<UpdateByQueryRequest,UpdateByQueryAction>

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.rest.BaseRestHandler

BaseRestHandler.RestChannelConsumer, BaseRestHandler.Wrapper

Nested classes/interfaces inherited from interface org.opensearch.rest.RestHandler

RestHandler.DeprecatedRoute, RestHandler.ReplacedRoute, RestHandler.Route

Field Summary

Fields inherited from class org.opensearch.rest.BaseRestHandler

DUPLICATE_PARAMETER_ERROR_MESSAGE, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestUpdateByQueryAction()

Method Summary

Modifier and Type	Method	Description
protected UpdateByQueryRequest	buildRequest(RestRequest request, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)	Build the Request based on the RestRequest.
String	getName()
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)
List<RestHandler.Route>	routes()

Methods inherited from class org.opensearch.index.reindex.AbstractBulkByQueryRestHandler

parseInternalRequest

Methods inherited from class org.opensearch.index.reindex.AbstractBaseReindexRestHandler

doPrepareRequest, parseRequestsPerSecond, setCommonOptions

Methods inherited from class org.opensearch.rest.BaseRestHandler

getUsageCount, handleRequest, parseDeprecatedMasterTimeoutParameter, responseParams, sendTask, unrecognized, unrecognizedStrings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.rest.RestHandler

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes, supportsContentStream

Constructor Details

RestUpdateByQueryAction

public RestUpdateByQueryAction()

Method Details

routes

public List<RestHandler.Route> routes()

getName

public String getName()

Specified by:

getName in class BaseRestHandler

prepareRequest

public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request,
 NodeClient client)
                                                   throws IOException

Specified by:

prepareRequest in class BaseRestHandler

Throws:

IOException

buildRequest

protected UpdateByQueryRequest buildRequest(RestRequest request,
 org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)
                                     throws IOException

Description copied from class: AbstractBaseReindexRestHandler

Build the Request based on the RestRequest.

Specified by:

buildRequest in class AbstractBaseReindexRestHandler<UpdateByQueryRequest,UpdateByQueryAction>

Throws:

IOException