module Elasticsearch::API::Ingest::Actions

Public Instance Methods

delete_geoip_database(arguments = {}) click to toggle source

Deletes a geoip database configuration

@option arguments [List] :id A comma-separated list of geoip database configurations to delete @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-geoip-database-api.html

# File lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb, line 32
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 = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
delete_ip_location_database(arguments = {}) click to toggle source

Deletes an ip location database configuration

@option arguments [List] :id A comma-separated list of ip location database configurations to delete @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-ip-location-database-api.html

# File lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb, line 32
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 = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
delete_pipeline(arguments = {}) click to toggle source

Deletes a pipeline.

@option arguments [String] :id Pipeline ID @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @option arguments [Time] :timeout Explicit operation timeout @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/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 = {}) click to toggle source

Returns statistical information about geoip databases

@option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/geoip-stats-api.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 = {}) click to toggle source

Returns geoip database configuration.

@option arguments [List] :id A comma-separated list of geoip database configurations to get; use ‘*` to get all geoip database configurations @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/get-geoip-database-api.html

# 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 = {}) click to toggle source

Returns the specified ip location database configuration

@option arguments [List] :id A comma-separated list of ip location database configurations to get; use ‘*` to get all ip location database configurations @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/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 = {}) click to toggle source

Returns a pipeline.

@option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/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 = {}) click to toggle source

Returns a list of the built-in patterns.

@option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/grok-processor.html#grok-processor-rest-get

# 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 = {}) click to toggle source

Puts the configuration for a geoip database to be downloaded

@option arguments [String] :id The id of the database configuration @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The database configuration definition (Required)

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/put-geoip-database-api.html

# File lib/elasticsearch/api/actions/ingest/put_geoip_database.rb, line 33
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 = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
put_ip_location_database(arguments = {}) click to toggle source

Puts the configuration for a ip location database to be downloaded

@option arguments [String] :id The id of the database configuration @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The database configuration definition (Required)

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/put-ip-location-database-api.html

# File lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb, line 33
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 = {}

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
put_pipeline(arguments = {}) click to toggle source

Creates or updates a pipeline.

@option arguments [String] :id Pipeline ID @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node @option arguments [Time] :timeout Explicit operation timeout @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The ingest definition (Required)

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/put-pipeline-api.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 = {}) click to toggle source

Allows to simulate a pipeline with example documents.

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

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/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