module Elasticsearch::API::License::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/license/delete.rb, line 35 def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.delete' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_DELETE path = '_license' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Delete the license. When the license expires, your subscription level reverts to Basic. If the operator privileges feature is enabled, only operator users can use this API
.
@option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-delete
Source
# File lib/elasticsearch/api/actions/license/get.rb, line 35 def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_license' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get license information. Get information about your Elastic license including its type, its status, when it was issued, and when it expires.
@option arguments [Boolean] :accept_enterprise If true
, this parameter returns enterprise for Enterprise license types. If false
, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility.
This parameter is deprecated and will always be set to true in 8.x. Server default: true.
@option arguments [Boolean] :local Specifies whether to retrieve local information. The default value is false
, which means the information is retrieved from the master node. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get
Source
# File lib/elasticsearch/api/actions/license/get_basic_status.rb, line 31 def get_basic_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get_basic_status' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_license/basic_status' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get the basic license status.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-basic-status
Source
# File lib/elasticsearch/api/actions/license/get_trial_status.rb, line 31 def get_trial_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get_trial_status' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_license/trial_status' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get the trial status.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-trial-status
Source
# File lib/elasticsearch/api/actions/license/post.rb, line 41 def post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = arguments.delete(:body) method = Elasticsearch::API::HTTP_PUT path = '_license' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Update the license. You can update your license at runtime without shutting down your nodes. License
updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API
request with the acknowledge parameter set to true. NOTE: If Elasticsearch
security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API
.
@option arguments [Boolean] :acknowledge Specifies whether you acknowledge the license changes. @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body request body
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post
Source
# File lib/elasticsearch/api/actions/license/post_start_basic.rb, line 39 def post_start_basic(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_basic' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_POST path = '_license/start_basic' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Start a basic license. Start an indefinite basic license, which gives access to all the basic features. NOTE: In order to start a basic license, you must not currently have a basic license. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API
request with the acknowledge
parameter set to true
. To check the status of your basic license, use the get basic license API
.
@option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-basic
Source
# File lib/elasticsearch/api/actions/license/post_start_trial.rb, line 38 def post_start_trial(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_trial' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_POST path = '_license/start_trial' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Start a trial. Start a 30-day trial, which gives access to all subscription features. NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at www.elastic.co/trialextension. To check the status of your trial, use the get trial status API
.
@option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) @option arguments [String] :type_query_string [TODO] @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-trial