module Elasticsearch::API::Ingest::Actions

Public Instance Methods

delete_pipeline(arguments={}) click to toggle source

Delete a speficied pipeline

@option arguments [String] :id Pipeline ID (Required) @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @option arguments [Time] :timeout Explicit operation timeout

@see www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html

# File lib/elasticsearch/api/actions/ingest/delete_pipeline.rb, line 14
def delete_pipeline(arguments={})
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
  valid_params = [
    :master_timeout,
    :timeout ]
  method = 'DELETE'
  path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
  params = Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end
get_pipeline(arguments={}) click to toggle source

Return a specified pipeline

@option arguments [String] :id Comma separated list of pipeline ids (wildcards supported). @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node

@see www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html

# File lib/elasticsearch/api/actions/ingest/get_pipeline.rb, line 13
def get_pipeline(arguments={})
  valid_params = [
    :master_timeout ]
  method = 'GET'
  path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
  params = Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end
put_pipeline(arguments={}) click to toggle source

Add or update a specified pipeline

@option arguments [String] :id Pipeline ID (Required) @option arguments [Hash] :body The ingest definition (Required) @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @option arguments [Time] :timeout Explicit operation timeout

@see www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html

# File lib/elasticsearch/api/actions/ingest/put_pipeline.rb, line 15
def put_pipeline(arguments={})
  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  valid_params = [
    :master_timeout,
    :timeout ]
  method = 'PUT'
  path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])

  params = Utils.__validate_and_extract_params arguments, valid_params
  body   = arguments[:body]

  perform_request(method, path, params, body).body
end
simulate(arguments={}) click to toggle source

Execute a specific pipeline against the set of documents provided in the body of the request

@option arguments [String] :id Pipeline ID @option arguments [Hash] :body The pipeline definition (Required) @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor

in executed pipeline

@see www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html

# File lib/elasticsearch/api/actions/ingest/simulate.rb, line 15
def simulate(arguments={})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  valid_params = [
    :verbose ]
  method = 'GET'
  path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id]), '_simulate'
  params = Utils.__validate_and_extract_params arguments, valid_params
  body   = arguments[:body]

  perform_request(method, path, params, body).body
end