lib/elasticsearch/api/actions/count.rb in elasticsearch-api-6.2.0 vs lib/elasticsearch/api/actions/count.rb in elasticsearch-api-6.3.0
- old
+ new
@@ -17,36 +17,25 @@
# index: 'my_index', body: { filtered: { filter: { terms: { foo: ['bar'] } } } }
#
# @option arguments [List] :index A comma-separated list of indices to restrict the results
# @option arguments [List] :type A comma-separated list of types to restrict the results
# @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
- # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
- # unavailable (missing or closed)
- # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves
- # into no concrete indices.
- # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
- # that are open, closed or both.
- # (options: open, closed, none, all)
+ # @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, none, all)
# @option arguments [Number] :min_score Include only documents with a specific `_score` value in the result
- # @option arguments [String] :preference Specify the node or shard the operation should be performed on
- # (default: random)
- # @option arguments [String] :routing Specific routing value
+ # @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 [String] :q Query in the Lucene query string syntax
# @option arguments [String] :analyzer The analyzer to use for the query string
- # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be
- # analyzed (default: false)
- # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
- # (options: AND, OR)
- # @option arguments [String] :df The field to use as default where no field prefix is given in the query
- # string
- # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text
- # to a numeric field) should be ignored
- # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
+ # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+ # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+ # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
+ # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+ # @option arguments [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early
#
- # @option arguments [Boolean] :terminate_after Specify the maximum count for each shard, upon reaching
- # which the query execution will terminate early.
- #
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
#
def count(arguments={})
method = HTTP_GET
path = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_count' )
@@ -60,10 +49,11 @@
# Register this action with its valid params when the module is loaded.
#
# @since 6.2.0
ParamsRegistry.register(:count, [
:ignore_unavailable,
+ :ignore_throttled,
:allow_no_indices,
:expand_wildcards,
:min_score,
:preference,
:routing,
@@ -71,10 +61,9 @@
:analyzer,
:analyze_wildcard,
:default_operator,
:df,
:lenient,
- :lowercase_expanded_terms,
:terminate_after ].freeze)
end
end
end