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

Included in:
CatClient
Defined in:
lib/elasticsearch/xpack/api/namespace/cat.rb,
lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb,
lib/elasticsearch/xpack/api/actions/cat/transform.rb,
lib/elasticsearch/xpack/api/actions/cat/transforms.rb,
lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb,
lib/elasticsearch/xpack/api/actions/cat/params_registry.rb,
lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb,
lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#ml_data_frame_analytics(arguments = {}) ⇒ Object

Gets configuration and usage information about data frame analytics jobs.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :id (String) —

    The ID of the data frame analytics to fetch

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no configs. (This includes ‘_all` string or when no configs have been specified)

  • :bytes (String) —

    The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)

  • :format (String) —

    a short version of the Accept header, e.g. json, yaml

  • :h (List) —

    Comma-separated list of column names to display

  • :help (Boolean) —

    Return help information

  • :s (List) —

    Comma-separated list of column names or column aliases to sort by

  • :time (String) —

    The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)

  • :v (Boolean) —

    Verbose mode. Display column headers

  • :headers (Hash) —

    Custom HTTP headers

See Also:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb', line 38

def ml_data_frame_analytics(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _id = arguments.delete(:id)

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

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

#ml_datafeeds(arguments = {}) ⇒ Object

Gets configuration and usage information about datafeeds.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :datafeed_id (String) —

    The ID of the datafeeds stats to fetch

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no datafeeds. (This includes ‘_all` string or when no datafeeds have been specified)

  • :allow_no_datafeeds (Boolean) —

    Whether to ignore if a wildcard expression matches no datafeeds. (This includes ‘_all` string or when no datafeeds have been specified) Deprecated

  • :format (String) —

    a short version of the Accept header, e.g. json, yaml

  • :h (List) —

    Comma-separated list of column names to display

  • :help (Boolean) —

    Return help information

  • :s (List) —

    Comma-separated list of column names or column aliases to sort by

  • :time (String) —

    The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)

  • :v (Boolean) —

    Verbose mode. Display column headers

  • :headers (Hash) —

    Custom HTTP headers

See Also:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb', line 38

def ml_datafeeds(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _datafeed_id = arguments.delete(:datafeed_id)

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

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

#ml_jobs(arguments = {}) ⇒ Object

Gets configuration and usage information about anomaly detection jobs.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :job_id (String) —

    The ID of the jobs stats to fetch

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no jobs. (This includes ‘_all` string or when no jobs have been specified)

  • :allow_no_jobs (Boolean) —

    Whether to ignore if a wildcard expression matches no jobs. (This includes ‘_all` string or when no jobs have been specified) Deprecated

  • :bytes (String) —

    The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)

  • :format (String) —

    a short version of the Accept header, e.g. json, yaml

  • :h (List) —

    Comma-separated list of column names to display

  • :help (Boolean) —

    Return help information

  • :s (List) —

    Comma-separated list of column names or column aliases to sort by

  • :time (String) —

    The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)

  • :v (Boolean) —

    Verbose mode. Display column headers

  • :headers (Hash) —

    Custom HTTP headers

See Also:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb', line 39

def ml_jobs(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _job_id = arguments.delete(:job_id)

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

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

#ml_trained_models(arguments = {}) ⇒ Object

Gets configuration and usage information about inference trained models.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :model_id (String) —

    The ID of the trained models stats to fetch

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no trained models. (This includes ‘_all` string or when no trained models have been specified)

  • :from (Integer) —

    skips a number of trained models

  • :size (Integer) —

    specifies a max number of trained models to get

  • :bytes (String) —

    The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)

  • :format (String) —

    a short version of the Accept header, e.g. json, yaml

  • :h (List) —

    Comma-separated list of column names to display

  • :help (Boolean) —

    Return help information

  • :s (List) —

    Comma-separated list of column names or column aliases to sort by

  • :time (String) —

    The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)

  • :v (Boolean) —

    Verbose mode. Display column headers

  • :headers (Hash) —

    Custom HTTP headers

See Also:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb', line 40

def ml_trained_models(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _model_id = arguments.delete(:model_id)

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

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

#transform(arguments = {}) ⇒ Object

See Also:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/xpack/api/actions/cat/transform.rb', line 42

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

  _transform_id = arguments.delete(:transform_id)

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

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

#transforms(arguments = {}) ⇒ Object

Gets configuration and usage information about transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform for which to get stats. ‘_all’ or ‘*’ implies all transforms

  • :from (Integer) —

    skips a number of transform configs, defaults to 0

  • :size (Integer) —

    specifies a max number of transforms to get, defaults to 100

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no transforms. (This includes ‘_all` string or when no transforms have been specified)

  • :format (String) —

    a short version of the Accept header, e.g. json, yaml

  • :h (List) —

    Comma-separated list of column names to display

  • :help (Boolean) —

    Return help information

  • :s (List) —

    Comma-separated list of column names or column aliases to sort by

  • :time (String) —

    The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)

  • :v (Boolean) —

    Verbose mode. Display column headers

  • :headers (Hash) —

    Custom HTTP headers

See Also:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/elasticsearch/xpack/api/actions/cat/transforms.rb', line 39

def transforms(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

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

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