elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb
# Returns information about the indices and shards that a search request would be executed against.
#
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
# @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 [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @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, hidden, none, all)
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html
#
Returns information about the indices and shards that a search request would be executed against.
Returns information about the indices and shards that a search request would be executed against .
def search_shards(arguments = {})
        headers = arguments.delete(:headers) || {}
        body = nil
        arguments = arguments.clone
        _index = arguments.delete(:index)
        method = Elasticsearch::API::HTTP_GET
        path   = if _index
                   "#{Utils.__listify(_index)}/_search_shards"
                 else
                   "_search_shards"
                 end
        params = Utils.process_params(arguments)
        perform_request(method, path, params, body, headers).body
      end
def search_shards ( arguments = { } ) headers = arguments . delete ( :headers ) || { } body = nil arguments = arguments . clone _index = arguments . delete ( :index ) method = Elasticsearch :: API :: HTTP_GET path = if _index "#{Utils.__listify(_index)}/_search_shards" else "_search_shards" end params = Utils . process_params ( arguments ) perform_request ( method , path , params , body , headers ) . body end
Returns information about the indices and shards that a search request would be executed against.
Returns information about the indices and shards that a search request would be executed against .
arguments
:headers Custom HTTP headers
: headers Custom HTTP headers
see
None