Module: Elasticsearch::API::Cat::Actions

Included in:
CatClient
Defined in:
lib/elasticsearch/api/namespace/cat.rb,
lib/elasticsearch/api/actions/cat/help.rb,
lib/elasticsearch/api/actions/cat/count.rb,
lib/elasticsearch/api/actions/cat/nodes.rb,
lib/elasticsearch/api/actions/cat/tasks.rb,
lib/elasticsearch/api/actions/cat/health.rb,
lib/elasticsearch/api/actions/cat/master.rb,
lib/elasticsearch/api/actions/cat/shards.rb,
lib/elasticsearch/api/actions/cat/aliases.rb,
lib/elasticsearch/api/actions/cat/indices.rb,
lib/elasticsearch/api/actions/cat/plugins.rb,
lib/elasticsearch/api/actions/cat/recovery.rb,
lib/elasticsearch/api/actions/cat/segments.rb,
lib/elasticsearch/api/actions/cat/fielddata.rb,
lib/elasticsearch/api/actions/cat/nodeattrs.rb,
lib/elasticsearch/api/actions/cat/snapshots.rb,
lib/elasticsearch/api/actions/cat/templates.rb,
lib/elasticsearch/api/actions/cat/allocation.rb,
lib/elasticsearch/api/actions/cat/thread_pool.rb,
lib/elasticsearch/api/actions/cat/repositories.rb,
lib/elasticsearch/api/actions/cat/pending_tasks.rb,
lib/elasticsearch/api/actions/cat/params_registry.rb

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#aliases(arguments = {}) ⇒ Object

See Also:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/elasticsearch/api/actions/cat/aliases.rb', line 22

def aliases(arguments = {})
  arguments = arguments.clone

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_cat/aliases/#{Utils.__listify(_name)}"
           else
             "_cat/aliases"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#allocation(arguments = {}) ⇒ Object

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/elasticsearch/api/actions/cat/allocation.rb', line 26

def allocation(arguments = {})
  arguments = arguments.clone

  _node_id = arguments.delete(:node_id)

  method = Elasticsearch::API::HTTP_GET
  path   = if _node_id
             "_cat/allocation/#{Utils.__listify(_node_id)}"
           else
             "_cat/allocation"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#count(arguments = {}) ⇒ Object

See Also:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/elasticsearch/api/actions/cat/count.rb', line 21

def count(arguments = {})
  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/count/#{Utils.__listify(_index)}"
           else
             "_cat/count"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#fielddata(arguments = {}) ⇒ Object

See Also:



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/elasticsearch/api/actions/cat/fielddata.rb', line 25

def fielddata(arguments = {})
  arguments = arguments.clone

  _fields = arguments.delete(:fields)

  method = Elasticsearch::API::HTTP_GET
  path   = if _fields
             "_cat/fielddata/#{Utils.__listify(_fields)}"
           else
             "_cat/fielddata"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#health(arguments = {}) ⇒ Object

See Also:



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/elasticsearch/api/actions/cat/health.rb', line 24

def health(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/health"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#help(arguments = {}) ⇒ Object

See Also:



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/elasticsearch/api/actions/cat/help.rb', line 17

def help(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#indices(arguments = {}) ⇒ Object

See Also:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/elasticsearch/api/actions/cat/indices.rb', line 34

def indices(arguments = {})
  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/indices/#{Utils.__listify(_index)}"
           else
             "_cat/indices"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#master(arguments = {}) ⇒ Object

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/elasticsearch/api/actions/cat/master.rb', line 22

def master(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/master"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#nodeattrs(arguments = {}) ⇒ Object

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/elasticsearch/api/actions/cat/nodeattrs.rb', line 22

def nodeattrs(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/nodeattrs"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#nodes(arguments = {}) ⇒ Object

See Also:



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/elasticsearch/api/actions/cat/nodes.rb', line 29

def nodes(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/nodes"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h], escape: false) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#pending_tasks(arguments = {}) ⇒ Object

See Also:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/elasticsearch/api/actions/cat/pending_tasks.rb', line 25

def pending_tasks(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/pending_tasks"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#plugins(arguments = {}) ⇒ Object

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/elasticsearch/api/actions/cat/plugins.rb', line 22

def plugins(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/plugins"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#recovery(arguments = {}) ⇒ Object

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/elasticsearch/api/actions/cat/recovery.rb', line 30

def recovery(arguments = {})
  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/recovery/#{Utils.__listify(_index)}"
           else
             "_cat/recovery"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#repositories(arguments = {}) ⇒ Object

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/elasticsearch/api/actions/cat/repositories.rb', line 22

def repositories(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/repositories"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#segments(arguments = {}) ⇒ Object

See Also:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/elasticsearch/api/actions/cat/segments.rb', line 24

def segments(arguments = {})
  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/segments/#{Utils.__listify(_index)}"
           else
             "_cat/segments"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#shards(arguments = {}) ⇒ Object

See Also:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/elasticsearch/api/actions/cat/shards.rb', line 29

def shards(arguments = {})
  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/shards/#{Utils.__listify(_index)}"
           else
             "_cat/shards"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end

#snapshots(arguments = {}) ⇒ Object

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/elasticsearch/api/actions/cat/snapshots.rb', line 26

def snapshots(arguments = {})
  arguments = arguments.clone

  _repository = arguments.delete(:repository)

  method = Elasticsearch::API::HTTP_GET
  path   = if _repository
             "_cat/snapshots/#{Utils.__listify(_repository)}"
           else
             "_cat/snapshots"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#tasks(arguments = {}) ⇒ Object

See Also:



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/elasticsearch/api/actions/cat/tasks.rb', line 27

def tasks(arguments = {})
  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/tasks"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#templates(arguments = {}) ⇒ Object

See Also:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/elasticsearch/api/actions/cat/templates.rb', line 23

def templates(arguments = {})
  arguments = arguments.clone

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_cat/templates/#{Utils.__listify(_name)}"
           else
             "_cat/templates"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body).body
end

#thread_pool(arguments = {}) ⇒ Object

See Also:



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/elasticsearch/api/actions/cat/thread_pool.rb', line 27

def thread_pool(arguments = {})
  arguments = arguments.clone

  _thread_pool_patterns = arguments.delete(:thread_pool_patterns)

  method = Elasticsearch::API::HTTP_GET
  path   = if _thread_pool_patterns
             "_cat/thread_pool/#{Utils.__listify(_thread_pool_patterns)}"
           else
             "_cat/thread_pool"
end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body).body
end