Module: Elasticsearch::XPack::API::Migration::Actions

Included in:
MigrationClient
Defined in:
lib/elasticsearch/xpack/api/namespace/migration.rb,
lib/elasticsearch/xpack/api/actions/migration/deprecations.rb,
lib/elasticsearch/xpack/api/actions/migration/params_registry.rb,
lib/elasticsearch/xpack/api/actions/migration/post_feature_upgrade.rb,
lib/elasticsearch/xpack/api/actions/migration/get_feature_upgrade_status.rb

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#deprecations(arguments = {}) ⇒ Object

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.

Parameters:

  • arguments (Hash) (defaults to: {})

    a customizable set of options

Options Hash (arguments):

  • :index (String)

    Index pattern

  • :headers (Hash)

    Custom HTTP headers

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/elasticsearch/xpack/api/actions/migration/deprecations.rb', line 30

def deprecations(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _index = arguments.delete(:index)

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

  body = nil
  perform_request(method, path, params, body, headers).body
end

#get_feature_upgrade_status(arguments = {}) ⇒ Object

Find out whether system features need to be upgraded or not

Parameters:

  • arguments (Hash) (defaults to: {})

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash)

    Custom HTTP headers

See Also:



29
30
31
32
33
34
35
36
37
38
39
40
# File 'lib/elasticsearch/xpack/api/actions/migration/get_feature_upgrade_status.rb', line 29

def get_feature_upgrade_status(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

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

  body = nil
  perform_request(method, path, params, body, headers).body
end

#post_feature_upgrade(arguments = {}) ⇒ Object

Begin upgrades for system features

Parameters:

  • arguments (Hash) (defaults to: {})

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash)

    Custom HTTP headers

See Also:



29
30
31
32
33
34
35
36
37
38
39
40
# File 'lib/elasticsearch/xpack/api/actions/migration/post_feature_upgrade.rb', line 29

def post_feature_upgrade(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

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

  body = nil
  perform_request(method, path, params, body, headers).body
end