module Elasticsearch::API::XPack::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/xpack/info.rb, line 40 def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'xpack.info' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_xpack' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get information. The information provided by the API
includes:
-
Build information including the build number and timestamp.
-
License
information about the currently installed license. -
Feature information for the features that are currently enabled and available under the current license.
@option arguments [Array<String>] :categories A comma-separated list of the information categories to include in the response.
For example, +build,license,features+.
@option arguments [Boolean] :accept_enterprise If this param is used it must be set to true @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response.
In particular, it adds descriptions and a tag line. Server default: true.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-info
Source
# File lib/elasticsearch/api/actions/xpack/usage.rb, line 36 def usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'xpack.usage' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_xpack/usage' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get usage information. Get information about the features that are currently enabled and available under the current license. The API
also provides some usage statistics.
@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. To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack