module Elasticsearch::API::SearchableSnapshots::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb, line 38 def cache_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.cache_stats' } defined_params = [:node_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 _node_id = arguments.delete(:node_id) method = Elasticsearch::API::HTTP_GET path = if _node_id "_searchable_snapshots/#{Utils.listify(_node_id)}/cache/stats" else '_searchable_snapshots/cache/stats' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get cache statistics. Get statistics about the shared cache for partially mounted indices. 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, Array] :node_id The names of the nodes in the cluster to target. @option arguments [Time] :master_timeout [TODO] @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-cache-stats
Source
# File lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb, line 41 def clear_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.clear_cache' } 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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index "#{Utils.listify(_index)}/_searchable_snapshots/cache/clear" else '_searchable_snapshots/cache/clear' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices. 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, Array] :index A comma-separated list of data streams, indices, and aliases to clear from the cache.
It supports wildcards (+*+).
@option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have been specified) @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-clear-cache
Source
# File lib/elasticsearch/api/actions/searchable_snapshots/mount.rb, line 42 def mount(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.mount' } defined_params = [:repository, :snapshot].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 'repository' missing" unless arguments[:repository] raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot] arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) _repository = arguments.delete(:repository) _snapshot = arguments.delete(:snapshot) method = Elasticsearch::API::HTTP_POST path = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_mount" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API
for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes.
@option arguments [String] :repository The name of the repository containing the snapshot of the index to mount. (Required) @option arguments [String] :snapshot The name of the snapshot of the index to mount. (Required) @option arguments [Time] :master_timeout The period to wait for the master node.
If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
@option arguments [Boolean] :wait_for_completion If true, the request blocks until the operation is complete. @option arguments [String] :storage The mount option for the searchable snapshot index. Server default: full_copy. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-mount
Source
# File lib/elasticsearch/api/actions/searchable_snapshots/stats.rb, line 33 def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.stats' } 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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index "#{Utils.listify(_index)}/_searchable_snapshots/stats" else '_searchable_snapshots/stats' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get searchable snapshot statistics.
@option arguments [String, Array] :index A comma-separated list of data streams and indices to retrieve statistics for. @option arguments [String] :level Return stats aggregated at cluster, index or shard level @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-stats