lib/elasticsearch/api/actions/search_template.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/search_template.rb in elasticsearch-api-7.0.0.pre

- old
+ new

@@ -1,8 +1,21 @@ -# Licensed to Elasticsearch B.V under one or more agreements. -# Elasticsearch B.V licenses this file to you under the Apache 2.0 License. -# See the LICENSE file in the project root for more information +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. module Elasticsearch module API module Actions @@ -34,11 +47,12 @@ # @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, query_and_fetch, dfs_query_then_fetch, dfs_query_and_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 This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number + # @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 # # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html # def search_template(arguments={}) method = HTTP_GET @@ -49,11 +63,11 @@ perform_request(method, path, params, body).body end # Register this action with its valid params when the module is loaded. # - # @since 6.2.0 + # @since 6.1.1 ParamsRegistry.register(:search_template, [ :ignore_unavailable, :ignore_throttled, :allow_no_indices, :expand_wildcards, @@ -62,9 +76,10 @@ :scroll, :search_type, :explain, :profile, :typed_keys, - :rest_total_hits_as_int ].freeze) + :rest_total_hits_as_int, + :ccs_minimize_roundtrips ].freeze) end end end