Sha256: 5eefbda0cff06c77730cc18630e32cc9ffdb432f08964155deb0106585ab3509

Contents?: true

Size: 1.72 KB

Versions: 4

Compression:

Stored size: 1.72 KB

Contents

module Elasticsearch
  module API
    module Cluster
      module Actions

        # Perform manual shard allocation in the cluster.
        #
        # Pass the operations you want to perform in the `:body` option. Use the `dry_run` option to
        # evaluate the result of operations without actually performing them.
        #
        # @example Move shard `0` of index `myindex` from node named _Node1_ to node named _Node2_
        #
        #     client.cluster.reroute body: {
        #       commands: [
        #         { move: { index: 'myindex', shard: 0, from_node: 'Node1', to_node: 'Node2' } }
        #       ]
        #     }
        #
        # @note If you want to explicitely set the shard allocation to a certain node, you might
        #       want to look at the `allocation.*` cluster settings.
        #
        # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
        # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state
        # @option arguments [Boolean] :explain Return an explanation for why the commands can or cannot be executed
        # @option arguments [Boolean] :filter_metadata Don't return cluster state metadata (default: false)
        #
        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
        #
        def reroute(arguments={})
          valid_params = [ :dry_run, :explain, :filter_metadata ]

          method = 'POST'
          path   = "_cluster/reroute"

          params = Utils.__validate_and_extract_params arguments, valid_params
          body   = arguments[:body] || {}

          perform_request(method, path, params, body).body
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
elasticsearch-api-1.0.5 lib/elasticsearch/api/actions/cluster/reroute.rb
elasticsearch-api-1.0.4 lib/elasticsearch/api/actions/cluster/reroute.rb
elasticsearch-api-1.0.2 lib/elasticsearch/api/actions/cluster/reroute.rb
elasticsearch-api-1.0.1 lib/elasticsearch/api/actions/cluster/reroute.rb