Package org.opensearch.index.reindex

Class RestUpdateByQueryAction

java.lang.Object

org.opensearch.rest.BaseRestHandler

org.opensearch.index.reindex.AbstractBaseReindexRestHandler<Request,A>

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

DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestUpdateByQueryAction()

Method Summary

Modifier and Type	Method	Description
protected UpdateByQueryRequest	buildRequest(RestRequest request, NamedWriteableRegistry namedWriteableRegistry)	Build the Request based on the RestRequest.
java.lang.String	getName()
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)
java.util.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, responseParams, unrecognized

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 Detail

RestUpdateByQueryAction

public RestUpdateByQueryAction()

Method Detail

routes

public java.util.List<RestHandler.Route> routes()

getName

public java.lang.String getName()

Specified by:

getName in class BaseRestHandler

prepareRequest

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

Specified by:

prepareRequest in class BaseRestHandler

Throws:

java.io.IOException

buildRequest

protected UpdateByQueryRequest buildRequest(RestRequest request,
                                            NamedWriteableRegistry namedWriteableRegistry)
                                     throws java.io.IOException

Description copied from class: AbstractBaseReindexRestHandler

Build the Request based on the RestRequest.

Specified by:

buildRequest in class AbstractBaseReindexRestHandler<UpdateByQueryRequest,UpdateByQueryAction>

Throws:

java.io.IOException