module Elastic::EnterpriseSearch::Actions

Public Instance Methods

health(arguments = {}) click to toggle source

Health - Get information on the health of a deployment and basic statistics around resource usage Get information on the health of a deployment and basic statistics around resource usage

@option arguments [Hash] :headers optional HTTP headers to send with the request

@see www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#health-api-example

# File lib/elastic/enterprise-search/api/health.rb, line 30
def health(arguments = {})
  headers = arguments.delete(:headers) || {}

  request(
    :get,
    'api/ent/v1/internal/health/',
    arguments,
    {},
    headers
  )
end
put_read_only(arguments = {}) click to toggle source

Read-Only - Update the read-only flag's state Update the read-only flag's state

@option arguments [Object] :body @option body [Boolean] :enabled @option arguments [Hash] :headers optional HTTP headers to send with the request

@see www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#setting-read-only-state

# File lib/elastic/enterprise-search/api/put_read_only.rb, line 32
def put_read_only(arguments = {})
  body = arguments.delete(:body) || {}
  headers = arguments.delete(:headers) || {}

  request(
    :put,
    'api/ent/v1/internal/read_only_mode/',
    arguments,
    body,
    headers
  )
end
read_only(arguments = {}) click to toggle source

Read-Only - Get the read-only flag's state Get the read-only flag's state

@option arguments [Hash] :headers optional HTTP headers to send with the request

@see www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#getting-read-only-state

# File lib/elastic/enterprise-search/api/read_only.rb, line 30
def read_only(arguments = {})
  headers = arguments.delete(:headers) || {}

  request(
    :get,
    'api/ent/v1/internal/read_only_mode/',
    arguments,
    {},
    headers
  )
end
stats(arguments = {}) click to toggle source

Stats - Get information about the resource usage of the application, the state of different internal queues, etc. Get information about the resource usage of the application, the state of different internal queues, etc.

@param arguments [Hash] endpoint arguments @option arguments [Array] :include Comma-separated list of stats to return @option arguments [Hash] :headers optional HTTP headers to send with the request

@see www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#stats-api-example

# File lib/elastic/enterprise-search/api/stats.rb, line 32
def stats(arguments = {})
  headers = arguments.delete(:headers) || {}

  request(
    :get,
    'api/ent/v1/internal/stats/',
    arguments,
    {},
    headers
  )
end
version(arguments = {}) click to toggle source

Version - Get version information for this server Get version information for this server

@option arguments [Hash] :headers optional HTTP headers to send with the request

@see www.elastic.co/guide/en/enterprise-search/current/management-apis.html

# File lib/elastic/enterprise-search/api/version.rb, line 30
def version(arguments = {})
  headers = arguments.delete(:headers) || {}

  request(
    :get,
    'api/ent/v1/internal/version/',
    arguments,
    {},
    headers
  )
end