Module: OpenSearch::API::Features::Actions

Included in:
FeaturesClient
Defined in:
lib/opensearch/api/namespace/features.rb,
lib/opensearch/api/actions/features/get_features.rb,
lib/opensearch/api/actions/features/reset_features.rb,
lib/opensearch/api/actions/features/params_registry.rb

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#get_features(arguments = {}) ⇒ Object

Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :master_timeout (Time) — default: DEPRECATED: use cluster_manager_timeout instead —

    Explicit operation timeout for connection to master node

  • :cluster_manager_timeout (Time) —

    Explicit operation timeout for connection to cluster_manager node

  • :headers (Hash) —

    Custom HTTP headers



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/opensearch/api/actions/features/get_features.rb', line 38

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

  arguments = arguments.clone

  method = OpenSearch::API::HTTP_GET
  path   = "_features"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

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

#reset_features(arguments = {}) ⇒ Object

Resets the internal state of features, usually by deleting system indices This functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/opensearch/api/actions/features/reset_features.rb', line 40

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

  arguments = arguments.clone

  method = OpenSearch::API::HTTP_POST
  path   = "_features/_reset"
  params = {}

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