module Elasticsearch::API::Ingest::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb, line 36 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 GeoIP database configurations. Delete one or more IP geolocation database configurations.
@option arguments [String, Array] :id A comma-separated list of geoip database configurations to delete (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-geoip-database
Source
# File lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb, line 38 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 IP geolocation database configurations.
@option arguments [String, Array] :id A comma-separated list of IP location database configurations. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. A value of +-1+ indicates that the request should never time out. Server default: 30s.
@option arguments [Time] :timeout The period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. A value of +-1+ indicates that the request should never time out. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-ip-location-database
Source
# File lib/elasticsearch/api/actions/ingest/delete_pipeline.rb, line 38 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
Delete pipelines. Delete one or more ingest pipelines.
@option arguments [String] :id Pipeline ID or wildcard expression of pipeline IDs used to limit the request.
To delete all ingest pipelines in a cluster, use a value of +*+. (*Required*)
@option arguments [Time] :master_timeout Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@option arguments [Time] :timeout Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-pipeline
Source
# File lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb, line 32 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 statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/reference/enrich-processor/geoip-processor
Source
# File lib/elasticsearch/api/actions/ingest/get_geoip_database.rb, line 35 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 GeoIP database configurations. Get information about one or more IP geolocation database configurations.
@option arguments [String, Array] :id A comma-separated list of database configuration IDs to retrieve.
Wildcard (+*+) expressions are supported. To get all database configurations, omit this parameter or use +*+.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-geoip-database
Source
# File lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb, line 37 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 = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get IP geolocation database configurations.
@option arguments [String, Array] :id Comma-separated list of database configuration IDs to retrieve.
Wildcard (+*+) expressions are supported. To get all database configurations, omit this parameter or use +*+.
@option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. A value of +-1+ indicates that the request should never time out. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-ip-location-database
Source
# File lib/elasticsearch/api/actions/ingest/get_pipeline.rb, line 39 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
Get pipelines. Get information about one or more ingest pipelines. This API
returns a local reference of the pipeline.
@option arguments [String] :id Comma-separated list of pipeline IDs to retrieve.
Wildcard (+*+) expressions are supported. To get all ingest pipelines, omit this parameter or use +*+.
@option arguments [Time] :master_timeout Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@option arguments [Boolean] :summary Return pipelines without their definitions (default: false) @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-pipeline
Source
# File lib/elasticsearch/api/actions/ingest/processor_grok.rb, line 34 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
Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/reference/enrich-processor/grok-processor
Source
# File lib/elasticsearch/api/actions/ingest/put_geoip_database.rb, line 37 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
Create or update a GeoIP database configuration. Refer to the create or update IP geolocation database configuration API
.
@option arguments [String] :id ID of the database configuration to create or update. (Required) @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-geoip-database
Source
# File lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb, line 39 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
Create or update an IP geolocation database configuration.
@option arguments [String] :id The database configuration identifier. (Required) @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. A value of +-1+ indicates that the request should never time out. Server default: 30s.
@option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. A value of +-1+ indicates that the request should never time out. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body configuration
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-ip-location-database
Source
# File lib/elasticsearch/api/actions/ingest/put_pipeline.rb, line 37 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
Create or update a pipeline. Changes made using this API
take effect immediately.
@option arguments [String] :id ID of the ingest pipeline to create or update. (Required) @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines
Source
# File lib/elasticsearch/api/actions/ingest/simulate.rb, line 37 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
Simulate
a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.
@option arguments [String] :id The pipeline to test.
If you don't specify a +pipeline+ in the request body, this parameter is required.
@option arguments [Boolean] :verbose If true
, the response includes output data for each processor in the executed pipeline. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-simulate