module Elasticsearch::API::Fleet::Actions
Public Instance Methods
Deletes a secret stored by Fleet
. 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] :id The ID of the secret @option arguments [Hash] :headers Custom HTTP headers
@see [TODO]
# File lib/elasticsearch/api/actions/fleet/delete_secret.rb, line 36 def delete_secret(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.delete_secret' } 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 = "_fleet/secret/#{Utils.__listify(_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Retrieves a secret stored by Fleet
. 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] :id The ID of the secret @option arguments [Hash] :headers Custom HTTP headers
@see [TODO]
# File lib/elasticsearch/api/actions/fleet/get_secret.rb, line 36 def get_secret(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.get_secret' } 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_GET path = "_fleet/secret/#{Utils.__listify(_id)}" params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Returns the current global checkpoints for an index. This API
is design for internal use by the fleet server project.
@option arguments [String] :index The name of the index. @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints @option arguments [Boolean] :wait_for_index Whether to wait for the target index to exist and all primary shards be active @option arguments [List] :checkpoints Comma separated list of checkpoints @option arguments [Time] :timeout Timeout to wait for global checkpoint to advance @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/8.16/get-global-checkpoints.html
# File lib/elasticsearch/api/actions/fleet/global_checkpoints.rb, line 36 def global_checkpoints(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.global_checkpoints' } defined_params = [:index].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 'index' missing" unless arguments[:index] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = "#{Utils.__listify(_index)}/_fleet/global_checkpoints" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Multi Search API
where the search will only be executed after specified checkpoints are available due to a refresh. This API
is designed for internal use by the fleet server project. 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] :index The index name to use as the default @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The request definitions (metadata-fleet search request definition pairs), separated by newlines (Required)
@see [TODO]
# File lib/elasticsearch/api/actions/fleet/msearch.rb, line 37 def msearch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.msearch' } defined_params = [:index].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) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index "#{Utils.__listify(_index)}/_fleet/_fleet_msearch" else '_fleet/_fleet_msearch' end params = {} if body.is_a?(Array) && body.any? { |d| d.has_key? :search } payload = body.each_with_object([]) do |item, sum| meta = item data = meta.delete(:search) sum << meta sum << data end.map { |item| Elasticsearch::API.serializer.dump(item) } payload << '' unless payload.empty? payload = payload.join("\n") elsif body.is_a?(Array) payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) } payload << '' unless payload.empty? payload = payload.join("\n") else payload = body end headers.merge!('Content-Type' => 'application/x-ndjson') Elasticsearch::API::Response.new( perform_request(method, path, params, payload, headers, request_opts) ) end
Creates a secret stored by Fleet
. 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 [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The secret value to store (Required)
@see [TODO]
# File lib/elasticsearch/api/actions/fleet/post_secret.rb, line 36 def post_secret(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.post_secret' } raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_fleet/secret' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Search API
where the search will only be executed after specified checkpoints are available due to a refresh. This API
is designed for internal use by the fleet server project. 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] :index The index name to search. @option arguments [List] :wait_for_checkpoints Comma separated list of checkpoints, one per shard @option arguments [Time] :wait_for_checkpoints_timeout Explicit wait_for_checkpoints timeout @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The search definition using the Query DSL
@see [TODO]
# File lib/elasticsearch/api/actions/fleet/search.rb, line 40 def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.search' } defined_params = [:index].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 'index' missing" unless arguments[:index] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _index = arguments.delete(:index) method = if body Elasticsearch::API::HTTP_POST else Elasticsearch::API::HTTP_GET end path = "#{Utils.__listify(_index)}/_fleet/_fleet_search" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end