Contents

# Licensed to Elasticsearch B.V under one or more agreements.
# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
# See the LICENSE file in the project root for more information

module Elasticsearch
  module XPack
    module API
      module IndexLifecycleManagement
        module Actions
          # Shows an index’s current lifecycle status
          #
          # @option arguments [String] :index The target index (*Required*)
          # @option arguments [Time] :master_timeout Specifies the period of time to wait for a connection to the master node
          # @option arguments [Time] :timeout Specifies the period of time to wait for a response.
          #
          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
          #
          def explain(arguments = {})
            raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

            index = Elasticsearch::API::Utils.__escape(arguments.delete(:index))

            method = Elasticsearch::API::HTTP_GET
            path   = Elasticsearch::API::Utils.__pathify index, "_ilm/explain"
            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
            body   = nil

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

          # Register this action with its valid params when the module is loaded.
          #
          ParamsRegistry.register(:explain, [:master_timeout,
                                             :timeout].freeze)
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
elasticsearch-xpack-7.7.0	lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain.rb
elasticsearch-xpack-7.7.0.pre	lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain.rb
elasticsearch-xpack-7.6.0	lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain.rb
elasticsearch-xpack-7.6.0.pre	lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain.rb
elasticsearch-xpack-7.5.0	lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain.rb
elasticsearch-xpack-7.5.0.pre.pre	lib/elasticsearch/xpack/api/actions/index_lifecycle_management/explain.rb