vendor/bundle/jruby/2.3.0/gems/elasticsearch-api-5.0.4/lib/elasticsearch/api/actions/indices/close.rb
# Close an index (keep the data on disk, but deny operations with the index).
#
# A closed index can be opened again with the {Indices::Actions#close} API.
#
# @example Close index named _myindex_
#
#     client.indices.close index: 'myindex'
#
# @option arguments [List] :index A comma separated list of indices to perform the operation on
#                                 (*Required*)
# @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 [Time] :timeout Explicit operation timeout
#
# @see http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
#
Close an index (keep the data on disk, but deny operations with the index).
A closed index can be opened again with the {Indices::Actions#close} API.
Close an index ( keep the data on disk but deny operations with the index ) . A closed index can be opened again with the { Indices :: Actions#close } API .
def close(arguments={})
          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
          valid_params = [
            :ignore_indices,
            :ignore_unavailable,
            :allow_no_indices,
            :expand_wildcards,
            :timeout
          ]
          method = HTTP_POST
          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_close'
          params = Utils.__validate_and_extract_params arguments, valid_params
          body   = nil
          perform_request(method, path, params, body).body
        end
def close ( arguments = { } ) raise ArgumentError , "Required argument 'index' missing" unless arguments [ :index ] valid_params = [ :ignore_indices , :ignore_unavailable , :allow_no_indices , :expand_wildcards , :timeout ] method = HTTP_POST path = Utils . __pathify Utils . __listify ( arguments [ :index ] ) , '_close' params = Utils . __validate_and_extract_params arguments , valid_params body = nil perform_request ( method , path , params , body ) . body end
Close an index (keep the data on disk, but deny operations with the index).
Close an index ( keep the data on disk but deny operations with the index ) .
arguments
:timeout Explicit operation timeout
: timeout Explicit operation timeout
example
Close index named _myindex_ client.indices.close index: 'myindex'
Close index named _myindex_ client . indices . close index : ' myindex '
see
None