module Elasticsearch::API::Migration::Actions

Public Instance Methods

deprecations(arguments = {}) click to toggle source

Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

@option arguments [String] :index Index pattern @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/migration-api-deprecation.html

# File lib/elasticsearch/api/actions/migration/deprecations.rb, line 32
def deprecations(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'migration.deprecations' }

  defined_params = [:index].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "#{Utils.__listify(_index)}/_migration/deprecations"
           else
             '_migration/deprecations'
           end
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
get_feature_upgrade_status(arguments = {}) click to toggle source

Find out whether system features need to be upgraded or not

@option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/migration-api-feature-upgrade.html

# File lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb, line 31
def get_feature_upgrade_status(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'migration.get_feature_upgrade_status' }

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_migration/system_features'
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
post_feature_upgrade(arguments = {}) click to toggle source

Begin upgrades for system features

@option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/migration-api-feature-upgrade.html

# File lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb, line 31
def post_feature_upgrade(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'migration.post_feature_upgrade' }

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  method = Elasticsearch::API::HTTP_POST
  path   = '_migration/system_features'
  params = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end