elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb
# Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
#
# @option arguments [String] :index The name of the index to explain
# @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM
# @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
#
Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
Retrieves information about the index ' s current lifecycle state such as the currently executing phase action and step .
def explain_lifecycle(arguments = {})
          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
          headers = arguments.delete(:headers) || {}
          body = nil
          arguments = arguments.clone
          _index = arguments.delete(:index)
          method = Elasticsearch::API::HTTP_GET
          path   = "#{Utils.__listify(_index)}/_ilm/explain"
          params = Utils.process_params(arguments)
          perform_request(method, path, params, body, headers).body
        end
def explain_lifecycle ( arguments = { } ) raise ArgumentError , "Required argument 'index' missing" unless arguments [ :index ] headers = arguments . delete ( :headers ) || { } body = nil arguments = arguments . clone _index = arguments . delete ( :index ) method = Elasticsearch :: API :: HTTP_GET path = "#{Utils.__listify(_index)}/_ilm/explain" params = Utils . process_params ( arguments ) perform_request ( method , path , params , body , headers ) . body end
Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
Retrieves information about the index ' s current lifecycle state such as the currently executing phase action and step .
arguments
:headers Custom HTTP headers
: headers Custom HTTP headers
see
None