Module: Elastic::EnterpriseSearch::Actions

Included in:
Client
Defined in:
lib/elastic/enterprise-search/api/stats.rb,
lib/elastic/enterprise-search/api/health.rb,
lib/elastic/enterprise-search/api/version.rb,
lib/elastic/enterprise-search/api/read_only.rb,
lib/elastic/enterprise-search/api/put_read_only.rb,
lib/elastic/enterprise-search/api/search_engines.rb

Instance Method Summary collapse

Instance Method Details

#health(arguments = {}) ⇒ Object

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

Parameters:

  • arguments (Hash) (defaults to: {}) —

    endpoint arguments

Options Hash (arguments):

  • :headers (Hash) —

    optional HTTP headers to send with the request

See Also:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/elastic/enterprise-search/api/health.rb', line 31

def health(arguments = {})
  headers = arguments.delete(:headers) || {}
  request(
    :get,
    'api/ent/v1/internal/health/',
    arguments,
    nil,
    headers
  )
end

#put_read_only(arguments = {}) ⇒ Object

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

Parameters:

  • arguments (Hash) (defaults to: {}) —

    endpoint arguments

  • body (Hash) —

    a customizable set of options

Options Hash (arguments):

  • :body (Hash) — default: Required: enabled
  • :headers (Hash) —

    optional HTTP headers to send with the request

Raises:

  • (ArgumentError)

See Also:



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/elastic/enterprise-search/api/put_read_only.rb', line 33

def put_read_only(arguments = {})
  raise ArgumentError, "Required parameter 'body (enabled)' missing" unless arguments[:body]

  body = arguments.delete(:body) || {}
  headers = arguments.delete(:headers) || {}
  request(
    :put,
    'api/ent/v1/internal/read_only_mode/',
    arguments,
    body,
    headers
  )
end

#read_only(arguments = {}) ⇒ Object

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

Parameters:

  • arguments (Hash) (defaults to: {}) —

    endpoint arguments

Options Hash (arguments):

  • :headers (Hash) —

    optional HTTP headers to send with the request

See Also:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/elastic/enterprise-search/api/read_only.rb', line 31

def read_only(arguments = {})
  headers = arguments.delete(:headers) || {}
  request(
    :get,
    'api/ent/v1/internal/read_only_mode/',
    arguments,
    nil,
    headers
  )
end

#search_engines(arguments = {}) ⇒ Object

SearchEngines - Retrieve information about search engines Retrieve information about search engines

Parameters:

  • arguments (Hash) (defaults to: {}) —

    endpoint arguments

Options Hash (arguments):

  • :headers (Hash) —

    optional HTTP headers to send with the request

See Also:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/elastic/enterprise-search/api/search_engines.rb', line 31

def search_engines(arguments = {})
  headers = arguments.delete(:headers) || {}
  request(
    :get,
    'api/search_engines/',
    arguments,
    nil,
    headers
  )
end

#stats(arguments = {}) ⇒ Object

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.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    endpoint arguments

Options Hash (arguments):

  • :include (Array) —

    Comma-separated list of stats to return

  • :headers (Hash) —

    optional HTTP headers to send with the request

See Also:



32
33
34
35
36
37
38
39
40
41
 
# 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,
    nil,
    headers
  )
end

#version(arguments = {}) ⇒ Object

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

Parameters:

  • arguments (Hash) (defaults to: {}) —

    endpoint arguments

Options Hash (arguments):

  • :headers (Hash) —

    optional HTTP headers to send with the request

See Also:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/elastic/enterprise-search/api/version.rb', line 31

def version(arguments = {})
  headers = arguments.delete(:headers) || {}
  request(
    :get,
    'api/ent/v1/internal/version/',
    arguments,
    nil,
    headers
  )
end