elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb
# Allows to use the Mustache language to pre-render a search definition.
#
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
# @option arguments [List] :routing A comma-separated list of specific routing values
# @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
# @option arguments [Boolean] :profile Specify whether to profile the query execution
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
# @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
# @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The search definition template and its params (*Required*)
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html
#
Allows to use the Mustache language to pre-render a search definition.
Allows to use the Mustache language to pre - render a search definition .
def search_template(arguments = {})
        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
        headers = arguments.delete(:headers) || {}
        body = arguments.delete(:body)
        arguments = arguments.clone
        _index = arguments.delete(:index)
        method = Elasticsearch::API::HTTP_POST
        path   = if _index
                   "#{Utils.__listify(_index)}/_search/template"
                 else
                   "_search/template"
                 end
        params = Utils.process_params(arguments)
        perform_request(method, path, params, body, headers).body
      end
def search_template ( arguments = { } ) raise ArgumentError , "Required argument 'body' missing" unless arguments [ :body ] headers = arguments . delete ( :headers ) || { } body = arguments . delete ( :body ) arguments = arguments . clone _index = arguments . delete ( :index ) method = Elasticsearch :: API :: HTTP_POST path = if _index "#{Utils.__listify(_index)}/_search/template" else "_search/template" end params = Utils . process_params ( arguments ) perform_request ( method , path , params , body , headers ) . body end
Allows to use the Mustache language to pre-render a search definition.
Allows to use the Mustache language to pre - render a search definition .
arguments
:body The search definition template and its params (*Required*)
: body The search definition template and its params ( * Required * )
see
None