vendor/bundle/jruby/2.3.0/gems/elasticsearch-api-5.0.4/lib/elasticsearch/api/actions/cluster/health.rb
# Returns information about cluster "health".
#
# @example Get the cluster health information
#
#     client.cluster.health
#
# @example Block the request until the cluster is in the "yellow" state
#
#     client.cluster.health wait_for_status: 'yellow'
#
# @option arguments [String] :index Limit the information returned to a specific index
# @option arguments [String] :level Specify the level of detail for returned information
#                                   (options: cluster, indices, shards)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
#                                    (default: false)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
# @option arguments [Number] :wait_for_nodes Wait until the specified number of nodes is available
# @option arguments [Number] :wait_for_relocating_shards Wait until the specified number of relocating
#                                                        shards is finished
# @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating
#                                                            shards in the cluster
# @option arguments [String] :wait_for_status Wait until cluster is in a specific state
#                                             (options: green, yellow, red)
# @option arguments [List] :wait_for_events Wait until all currently queued events with the given priorty
#                                           are processed (immediate, urgent, high, normal, low, languid)
#
# @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
#
Returns information about cluster "health".
Returns information about cluster " health " .
def health(arguments={})
          arguments = arguments.clone
          index     = arguments.delete(:index)
          valid_params = [
            :level,
            :local,
            :master_timeout,
            :timeout,
            :wait_for_active_shards,
            :wait_for_nodes,
            :wait_for_relocating_shards,
            :wait_for_no_relocating_shards,
            :wait_for_status,
            :wait_for_events ]
          method = HTTP_GET
          path   = Utils.__pathify "_cluster/health", Utils.__listify(index)
          params = Utils.__validate_and_extract_params arguments, valid_params
          body = nil
          perform_request(method, path, params, body).body
        end
def health ( arguments = { } ) arguments = arguments . clone index = arguments . delete ( :index ) valid_params = [ :level , :local , :master_timeout , :timeout , :wait_for_active_shards , :wait_for_nodes , :wait_for_relocating_shards , :wait_for_no_relocating_shards , :wait_for_status , :wait_for_events ] method = HTTP_GET path = Utils . __pathify "_cluster/health" , Utils . __listify ( index ) params = Utils . __validate_and_extract_params arguments , valid_params body = nil perform_request ( method , path , params , body ) . body end
Returns information about cluster "health".
Returns information about cluster " health " .
arguments
:wait_for_events Wait until all currently queued events with the given priorty are processed (immediate, urgent, high, normal, low, languid)
: wait_for_events Wait until all currently queued events with the given priorty are processed ( immediate urgent high normal low languid )
example
Get the cluster health information client.cluster.health
Get the cluster health information client . cluster . health
example
Block the request until the cluster is in the "yellow" state client.cluster.health wait_for_status: 'yellow'
Block the request until the cluster is in the " yellow " state client . cluster . health wait_for_status : ' yellow '
see
None