Class RestSearchAction

    • Field Detail


        public static final java.lang.String TOTAL_HITS_AS_INT_PARAM
        Indicates whether should be rendered as an integer or an object in the rest search response.
        See Also:
        Constant Field Values

        public static final java.lang.String TYPED_KEYS_PARAM
        See Also:
        Constant Field Values

        public static final java.lang.String TYPES_DEPRECATION_MESSAGE
        See Also:
        Constant Field Values
    • Constructor Detail

      • RestSearchAction

        public RestSearchAction​(RestController controller)
    • Method Detail

      • getName

        public java.lang.String getName()
        Specified by:
        getName in class BaseRestHandler
        the name of this handler. The name should be human readable and should describe the action that will performed when this API is called. This name is used in the response to the RestNodesUsageAction.
      • prepareRequest

        public BaseRestHandler.RestChannelConsumer prepareRequest​(RestRequest request,
                                                                  NodeClient client)
        Description copied from class: BaseRestHandler
        Prepare the request for execution. Implementations should consume all request params before returning the runnable for actual execution. Unconsumed params will immediately terminate execution of the request. However, some params are only used in processing the response; implementations can override BaseRestHandler.responseParams() to indicate such params.
        Specified by:
        prepareRequest in class BaseRestHandler
        request - the request to execute
        client - client for executing actions on the local node
        the action to execute
        Throws: - if an I/O exception occurred parsing the request and preparing for execution
      • parseSearchRequest

        public static void parseSearchRequest​(SearchRequest searchRequest,
                                              RestRequest request,
                                              XContentParser requestContentParser,
                                              java.util.function.IntConsumer setSize)
        Parses the rest request on top of the SearchRequest, preserving values that are not overridden by the rest request.
        requestContentParser - body of the request to read. This method does not attempt to read the body from the request parameter
        setSize - how the size url parameter is handled. udpate_by_query and regular search differ here.