lib/elasticsearch/api/actions/indices/refresh.rb in elasticsearch-api-6.2.0 vs lib/elasticsearch/api/actions/indices/refresh.rb in elasticsearch-api-6.3.0
- old
+ new
@@ -16,23 +16,16 @@
#
# client.indices.refresh index: 'myindex'
#
# @note The refresh operation can adversely affect indexing throughput when used too frequently.
#
- # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
- # to perform the operation on all indices
- # @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 [List] :index A comma-separated list of index names; 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] :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)
#
- # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh/
+ # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
#
def refresh(arguments={})
method = HTTP_POST
path = Utils.__pathify Utils.__listify(arguments[:index]), '_refresh'
@@ -44,10 +37,9 @@
# Register this action with its valid params when the module is loaded.
#
# @since 6.2.0
ParamsRegistry.register(:refresh, [
- :ignore_indices,
:ignore_unavailable,
:allow_no_indices,
:expand_wildcards ].freeze)
end
end