Module: Elasticsearch::API::Enrich::Actions

Included in:
EnrichClient
Defined in:
lib/elasticsearch/api/namespace/enrich.rb,
lib/elasticsearch/api/actions/enrich/stats.rb,
lib/elasticsearch/api/actions/enrich/get_policy.rb,
lib/elasticsearch/api/actions/enrich/put_policy.rb,
lib/elasticsearch/api/actions/enrich/delete_policy.rb,
lib/elasticsearch/api/actions/enrich/execute_policy.rb

Instance Method Summary collapse

Instance Method Details

#delete_policy(arguments = {}) ⇒ Object

Deletes an existing enrich policy and its enrich index.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :name (String) —

    The name of the enrich policy

  • :master_timeout (Time) —

    Timeout for processing on master node

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/api/actions/enrich/delete_policy.rb', line 33

def delete_policy(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'enrich.delete_policy' }

  defined_params = [:name].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?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_enrich/policy/#{Utils.__listify(_name)}"
  params = Utils.process_params(arguments)

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

#execute_policy(arguments = {}) ⇒ Object

Creates the enrich index for an existing enrich policy.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :name (String) —

    The name of the enrich policy

  • :wait_for_completion (Boolean) —

    Should the request should block until the execution is complete.

  • :master_timeout (Time) —

    Timeout for processing on master node

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/elasticsearch/api/actions/enrich/execute_policy.rb', line 34

def execute_policy(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'enrich.execute_policy' }

  defined_params = [:name].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?

  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

  body = nil

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_enrich/policy/#{Utils.__listify(_name)}/_execute"
  params = Utils.process_params(arguments)

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

#get_policy(arguments = {}) ⇒ Object

Gets information about an enrich policy.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :name (List) —

    A comma-separated list of enrich policy names

  • :master_timeout (Time) —

    Timeout for processing on master node

  • :headers (Hash) —

    Custom HTTP headers

See Also:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/elasticsearch/api/actions/enrich/get_policy.rb', line 33

def get_policy(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'enrich.get_policy' }

  defined_params = [:name].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

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_enrich/policy/#{Utils.__listify(_name)}"
           else
             '_enrich/policy'
           end
  params = Utils.process_params(arguments)

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

#put_policy(arguments = {}) ⇒ Object

Creates a new enrich policy.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :name (String) —

    The name of the enrich policy

  • :master_timeout (Time) —

    Timeout for processing on master node

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The enrich policy to register (Required)

Raises:

  • (ArgumentError)

See Also:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/elasticsearch/api/actions/enrich/put_policy.rb', line 34

def put_policy(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'enrich.put_policy' }

  defined_params = [:name].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?

  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

  body = arguments.delete(:body)

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_enrich/policy/#{Utils.__listify(_name)}"
  params = Utils.process_params(arguments)

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

#stats(arguments = {}) ⇒ Object

Gets enrich coordinator statistics and information about enrich policies that are currently executing.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :master_timeout (Time) —

    Timeout for processing on master node

  • :headers (Hash) —

    Custom HTTP headers

See Also:



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

def stats(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'enrich.stats' }

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

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_enrich/_stats'
  params = Utils.process_params(arguments)

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