Module: Elasticsearch::API::Ingest::Actions

Included in:

IngestClient

Defined in:

lib/elasticsearch/api/namespace/ingest.rb,
lib/elasticsearch/api/actions/ingest/simulate.rb,
lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb,
lib/elasticsearch/api/actions/ingest/get_pipeline.rb,
lib/elasticsearch/api/actions/ingest/put_pipeline.rb,
lib/elasticsearch/api/actions/ingest/processor_grok.rb,
lib/elasticsearch/api/actions/ingest/delete_pipeline.rb,
lib/elasticsearch/api/actions/ingest/get_geoip_database.rb,
lib/elasticsearch/api/actions/ingest/put_geoip_database.rb,
lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb,
lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb,
lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb,
lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb

Instance Method Summary

• #delete_geoip_database(arguments = {}) ⇒ Object

  Delete GeoIP database configurations.

• #delete_ip_location_database(arguments = {}) ⇒ Object

  Delete IP geolocation database configurations.

• #delete_pipeline(arguments = {}) ⇒ Object

  Delete pipelines.

• #geo_ip_stats(arguments = {}) ⇒ Object

  Get GeoIP statistics.

• #get_geoip_database(arguments = {}) ⇒ Object

  Get GeoIP database configurations.

• #get_ip_location_database(arguments = {}) ⇒ Object

  Get IP geolocation database configurations.

• #get_pipeline(arguments = {}) ⇒ Object

  Get pipelines.

• #processor_grok(arguments = {}) ⇒ Object

  Run a grok processor.

• #put_geoip_database(arguments = {}) ⇒ Object

  Create or update a GeoIP database configuration.

• #put_ip_location_database(arguments = {}) ⇒ Object

  Create or update an IP geolocation database configuration.

• #put_pipeline(arguments = {}) ⇒ Object

  Create or update a pipeline.

• #simulate(arguments = {}) ⇒ Object

  Simulate a pipeline.

Instance Method Details

#delete_geoip_database(arguments = {}) ⇒ Object

Delete GeoIP database configurations

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (List) —

  A comma-separated list of geoip database configurations to delete

• :master_timeout (Time) —

  Explicit operation timeout for connection to master node

• :timeout (Time) —

  Explicit operation timeout

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-delete-geoip-database

# File 'lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb', line 34

def delete_geoip_database(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_geoip_database' }

  defined_params = [:id].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 'id' missing" unless arguments[:id]

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

  body = nil

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_ingest/geoip/database/#{Utils.__listify(_id)}"
  params = Utils.process_params(arguments)

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

#delete_ip_location_database(arguments = {}) ⇒ Object

Delete IP geolocation database configurations

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (List) —

  A comma-separated list of ip location database configurations to delete

• :master_timeout (Time) —

  Explicit operation timeout for connection to master node

• :timeout (Time) —

  Explicit operation timeout

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-ip-location-database-api.html

# File 'lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb', line 34

def delete_ip_location_database(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_ip_location_database' }

  defined_params = [:id].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 'id' missing" unless arguments[:id]

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

  body = nil

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_ingest/ip_location/database/#{Utils.__listify(_id)}"
  params = Utils.process_params(arguments)

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

#delete_pipeline(arguments = {}) ⇒ Object

Delete pipelines

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (String) —

  Pipeline ID

• :master_timeout (Time) —

  Explicit operation timeout for connection to master node

• :timeout (Time) —

  Explicit operation timeout

• :headers (Hash) —

  Custom HTTP headers

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-pipeline-api.html

# File 'lib/elasticsearch/api/actions/ingest/delete_pipeline.rb', line 34

def delete_pipeline(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_pipeline' }

  defined_params = [:id].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 'id' missing" unless arguments[:id]

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

  body = nil

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_ingest/pipeline/#{Utils.__listify(_id)}"
  params = Utils.process_params(arguments)

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

#geo_ip_stats(arguments = {}) ⇒ Object

Get GeoIP statistics

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :headers (Hash) —

  Custom HTTP headers

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/geoip-processor.html

# File 'lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb', line 31

def geo_ip_stats(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.geo_ip_stats' }

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

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_ingest/geoip/stats'
  params = {}

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

#get_geoip_database(arguments = {}) ⇒ Object

Get GeoIP database configurations

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (List) —

  A comma-separated list of geoip database configurations to get; use ‘*` to get all geoip database configurations

• :headers (Hash) —

  Custom HTTP headers

See Also:

• https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-get-geoip-database

# File 'lib/elasticsearch/api/actions/ingest/get_geoip_database.rb', line 32

def get_geoip_database(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_geoip_database' }

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

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_GET
  path   = if _id
             "_ingest/geoip/database/#{Utils.__listify(_id)}"
           else
             '_ingest/geoip/database'
           end
  params = {}

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

#get_ip_location_database(arguments = {}) ⇒ Object

Get IP geolocation database configurations

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (List) —

  A comma-separated list of ip location database configurations to get; use ‘*` to get all ip location database configurations

• :headers (Hash) —

  Custom HTTP headers

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-ip-location-database-api.html

# File 'lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb', line 32

def get_ip_location_database(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_ip_location_database' }

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

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_GET
  path   = if _id
             "_ingest/ip_location/database/#{Utils.__listify(_id)}"
           else
             '_ingest/ip_location/database'
           end
  params = {}

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

#get_pipeline(arguments = {}) ⇒ Object

Get pipelines

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (String) —

  Comma separated list of pipeline ids. Wildcards supported

• :summary (Boolean) —

  Return pipelines without their definitions (default: false)

• :master_timeout (Time) —

  Explicit operation timeout for connection to master node

• :headers (Hash) —

  Custom HTTP headers

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-pipeline-api.html

# File 'lib/elasticsearch/api/actions/ingest/get_pipeline.rb', line 34

def get_pipeline(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_pipeline' }

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

  _id = arguments.delete(:id)

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

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

#processor_grok(arguments = {}) ⇒ Object

Run a grok processor

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :headers (Hash) —

  Custom HTTP headers

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/grok-processor.html

# File 'lib/elasticsearch/api/actions/ingest/processor_grok.rb', line 31

def processor_grok(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.processor_grok' }

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

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_ingest/processor/grok'
  params = {}

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

#put_geoip_database(arguments = {}) ⇒ Object

Create or update a GeoIP database configuration

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (String) —

  The id of the database configuration

• :master_timeout (Time) —

  Explicit operation timeout for connection to master node

• :timeout (Time) —

  Explicit operation timeout

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  The database configuration definition (Required)

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ingest-put-geoip-database

# File 'lib/elasticsearch/api/actions/ingest/put_geoip_database.rb', line 35

def put_geoip_database(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_geoip_database' }

  defined_params = [:id].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 'id' missing" unless arguments[:id]

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

  body = arguments.delete(:body)

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_ingest/geoip/database/#{Utils.__listify(_id)}"
  params = Utils.process_params(arguments)

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

#put_ip_location_database(arguments = {}) ⇒ Object

Create or update an IP geolocation database configuration

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (String) —

  The id of the database configuration

• :master_timeout (Time) —

  Explicit operation timeout for connection to master node

• :timeout (Time) —

  Explicit operation timeout

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  The database configuration definition (Required)

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-ip-location-database-api.html

# File 'lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb', line 35

def put_ip_location_database(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_ip_location_database' }

  defined_params = [:id].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 'id' missing" unless arguments[:id]

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

  body = arguments.delete(:body)

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_ingest/ip_location/database/#{Utils.__listify(_id)}"
  params = Utils.process_params(arguments)

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

#put_pipeline(arguments = {}) ⇒ Object

Create or update a pipeline

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (String) —

  Pipeline ID

• :if_version (Integer) —

  Required version for optimistic concurrency control for pipeline updates

• :master_timeout (Time) —

  Explicit operation timeout for connection to master node

• :timeout (Time) —

  Explicit operation timeout

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  The ingest definition (Required)

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ingest.html

# File 'lib/elasticsearch/api/actions/ingest/put_pipeline.rb', line 36

def put_pipeline(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_pipeline' }

  defined_params = [:id].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 'id' missing" unless arguments[:id]

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

  body = arguments.delete(:body)

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_ingest/pipeline/#{Utils.__listify(_id)}"
  params = Utils.process_params(arguments)

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

#simulate(arguments = {}) ⇒ Object

Simulate a pipeline

Parameters:

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

  a customizable set of options

Options Hash (arguments):

• :id (String) —

  Pipeline ID

• :verbose (Boolean) —

  Verbose mode. Display data output for each processor in executed pipeline

• :headers (Hash) —

  Custom HTTP headers

• :body (Hash) —

  The simulate definition (Required)

Raises:

• (ArgumentError)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/8.19/simulate-pipeline-api.html

# File 'lib/elasticsearch/api/actions/ingest/simulate.rb', line 34

def simulate(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ingest.simulate' }

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

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

  body = arguments.delete(:body)

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_POST
  path   = if _id
             "_ingest/pipeline/#{Utils.__listify(_id)}/_simulate"
           else
             '_ingest/pipeline/_simulate'
           end
  params = Utils.process_params(arguments)

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