module Elasticsearch::API::SearchApplication::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/search_application/delete.rb, line 37 def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete' } 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 = "_application/search_application/#{Utils.listify(_name)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Delete a search application. Remove a search application and its associated alias. Indices
attached to the search application are not removed. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
@option arguments [String] :name The name of the search application to delete. (Required) @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete
Source
# File lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb, line 37 def delete_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete_behavioral_analytics' } 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 = "_application/analytics/#{Utils.listify(_name)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Delete a behavioral analytics collection. The associated data stream is also deleted. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :name The name of the analytics collection to be deleted (Required) @option arguments [Hash] :headers Custom HTTP headers
Source
# File lib/elasticsearch/api/actions/search_application/get.rb, line 36 def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.get' } 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_GET path = "_application/search_application/#{Utils.listify(_name)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get search application details. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
@option arguments [String] :name The name of the search application (Required) @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get
Source
# File lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb, line 36 def get_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.get_behavioral_analytics' } 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 "_application/analytics/#{Utils.listify(_name)}" else '_application/analytics' end params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get behavioral analytics collections. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [Array<String>] :name A list of analytics collections to limit the returned information @option arguments [Hash] :headers Custom HTTP headers
Source
# File lib/elasticsearch/api/actions/search_application/list.rb, line 39 def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.list' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_application/search_application' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get search applications. Get information about search applications. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
@option arguments [String] :q Query in the Lucene query string syntax. @option arguments [Integer] :from Starting offset. Server default: 0. @option arguments [Integer] :size Specifies a max number of results to get. @option arguments [Hash] :headers Custom HTTP headers
Source
# File lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb, line 39 def post_behavioral_analytics_event(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.post_behavioral_analytics_event' } defined_params = [:collection_name, :event_type].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 'collection_name' missing" unless arguments[:collection_name] raise ArgumentError, "Required argument 'event_type' missing" unless arguments[:event_type] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _collection_name = arguments.delete(:collection_name) _event_type = arguments.delete(:event_type) method = Elasticsearch::API::HTTP_POST path = "_application/analytics/#{Utils.listify(_collection_name)}/event/#{Utils.listify(_event_type)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Create a behavioral analytics collection event. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :collection_name The name of the behavioral analytics collection. (Required) @option arguments [String] :event_type The analytics event type. (Required) @option arguments [Boolean] :debug Whether the response type has to include more details @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body payload
Source
# File lib/elasticsearch/api/actions/search_application/put.rb, line 38 def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.put' } 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 = "_application/search_application/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Create or update a search application. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
@option arguments [String] :name The name of the search application to be created or updated. (Required) @option arguments [Boolean] :create If true
, this request cannot replace or update existing Search Applications. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body search_application
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put
Source
# File lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb, line 36 def put_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.put_behavioral_analytics' } 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 = "_application/analytics/#{Utils.listify(_name)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Create a behavioral analytics collection. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :name The name of the analytics collection to be created or updated. (Required) @option arguments [Hash] :headers Custom HTTP headers
Source
# File lib/elasticsearch/api/actions/search_application/render_query.rb, line 41 def render_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.render_query' } 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 = arguments.delete(:body) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST path = "_application/search_application/#{Utils.listify(_name)}/_render_query" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Render a search application query. Generate an Elasticsearch
query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in params
, the parameter’s default value will be used. The API
returns the specific Elasticsearch
query that would be generated and run by calling the search application search API
. You must have read
privileges on the backing alias of the search application. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [String] :name The name of the search application to render teh query for. (Required) @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-render-query
Source
# File lib/elasticsearch/api/actions/search_application/search.rb, line 40 def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.search' } 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 = arguments.delete(:body) _name = arguments.delete(:name) method = if body Elasticsearch::API::HTTP_POST else Elasticsearch::API::HTTP_GET end path = "_application/search_application/#{Utils.listify(_name)}/_search" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Run a search application search. Generate and run an Elasticsearch
query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
@option arguments [String] :name The name of the search application to be searched. (Required) @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-search