lib/elasticsearch/api/actions/indices/flush.rb in elasticsearch-api-0.4.3 vs lib/elasticsearch/api/actions/indices/flush.rb in elasticsearch-api-0.4.4
- old
+ new
@@ -9,22 +9,34 @@
# It corresponds to a Lucene "commit" operation.
#
# @note The flush operation is handled automatically by Elasticsearch, you don't need to perform it manually.
#
# @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
- # @option arguments [Boolean] :force TODO: ?
- # @option arguments [Boolean] :full TODO: ?
- # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
- # (options: none, missing)
+ # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie.
+ # if no changes will be committed to the index. (Internal)
+ # @option arguments [Boolean] :full If set to true a new index writer is created and settings that have been
+ # changed related to the index writer will be refreshed. (Internal)
+ # @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)
+ # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
+ # `missing` ones (options: none, missing) @until 1.0
+ # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+ # unavailable (missing, closed, etc)
# @option arguments [Boolean] :refresh Refresh the index after performing the operation
#
# @see http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/
#
def flush(arguments={})
valid_params = [
:force,
:full,
:ignore_indices,
+ :ignore_unavailable,
+ :allow_no_indices,
+ :expand_wildcards,
:refresh ]
method = 'POST'
path = Utils.__pathify Utils.__listify(arguments[:index]), '_flush'