module Elasticsearch::XPack::API::Actions
Public Instance Methods
Retrieves information about the installed X-Pack features.
@option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features @option arguments [Boolean] :accept_enterprise If an enterprise license is installed, return the type and mode as 'enterprise' (default: false) @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/7.14/info-api.html
# File lib/elasticsearch/xpack/api/actions/info.rb, line 30 def info(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = Elasticsearch::API::HTTP_GET path = "_xpack" params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end
The terms enum API
can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. 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 [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body field name, string which is the prefix expected in matching terms, timeout and size for max number of results
@see www.elastic.co/guide/en/elasticsearch/reference/7.14/search-terms-enum.html
# File lib/elasticsearch/xpack/api/actions/terms_enum.rb, line 34 def terms_enum(arguments = {}) raise ArgumentError, "Required argument 'index' missing" unless arguments[:index] headers = arguments.delete(:headers) || {} arguments = arguments.clone _index = arguments.delete(:index) method = if arguments[:body] Elasticsearch::API::HTTP_POST else Elasticsearch::API::HTTP_GET end path = "#{Elasticsearch::API::Utils.__listify(_index)}/_terms_enum" params = {} body = arguments[:body] perform_request(method, path, params, body, headers).body end
Retrieves usage information about the installed X-Pack features.
@option arguments [Time] :master_timeout Specify timeout for watch write operation @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/guide/en/elasticsearch/reference/7.14/usage-api.html
# File lib/elasticsearch/xpack/api/actions/usage.rb, line 29 def usage(arguments = {}) headers = arguments.delete(:headers) || {} arguments = arguments.clone method = Elasticsearch::API::HTTP_GET path = "_xpack/usage" params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__) body = nil perform_request(method, path, params, body, headers).body end