Sha256: 744d82948a0c8309b1eb98403f864e60bfbdf539ac638b62feadba1408053dc6

Contents?: true

Size: 1.52 KB

Versions: 6

Compression:

Stored size: 1.52 KB

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
          # Retrieves a lifecycle policy
          #
          # @option arguments [String] :policy_id Identifier for the policy
          # @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-get-lifecycle.html
          #
          def get_policy(arguments = {})
            method = Elasticsearch::API::HTTP_GET
            path   = Elasticsearch::API::Utils.__pathify "_ilm/policy",
                                                         Elasticsearch::API::Utils.__escape(arguments[:policy_id])
            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(:get_policy, [: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/get_policy.rb
elasticsearch-xpack-7.7.0.pre lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_policy.rb
elasticsearch-xpack-7.6.0 lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_policy.rb
elasticsearch-xpack-7.6.0.pre lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_policy.rb
elasticsearch-xpack-7.5.0 lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_policy.rb
elasticsearch-xpack-7.5.0.pre.pre lib/elasticsearch/xpack/api/actions/index_lifecycle_management/get_policy.rb