Contents

module Elasticsearch
  module API
    module Cat
      module Actions

        # Display information about the segments in the shards of an index
        #
        # @example Display information for all indices
        #
        #     puts client.cat.segments
        #
        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
        # @option arguments [List] :h Comma-separated list of column names to display
        # @option arguments [Boolean] :help Return help information
        # @option arguments [Boolean] :v Verbose mode. Display column headers
        #
        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html
        #
        def segments(arguments={})
          valid_params = [
            :bytes,
            :h,
            :help,
            :v ]

          method = HTTP_GET
          path   = "_cat/segments"
          params = Utils.__validate_and_extract_params arguments, valid_params
          body   = nil

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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
elasticsearch-api-2.0.2	lib/elasticsearch/api/actions/cat/segments.rb
elasticsearch-api-2.0.1	lib/elasticsearch/api/actions/cat/segments.rb