module Elasticsearch::XPack::API::Cat::Actions

Public Instance Methods

ml_data_frame_analytics(arguments = {}) click to toggle source

Gets configuration and usage information about data frame analytics jobs.

@option arguments [String] :id The ID of the data frame analytics to fetch @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [List] :h Comma-separated list of column names to display @option arguments [Boolean] :help Return help information @option arguments [List] :s Comma-separated list of column names or column aliases to sort by @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-dfanalytics.html

# 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 = {}) click to toggle source

Gets configuration and usage information about datafeeds.

@option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) Deprecated @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [List] :h Comma-separated list of column names to display @option arguments [Boolean] :help Return help information @option arguments [List] :s Comma-separated list of column names or column aliases to sort by @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-datafeeds.html

# 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 = {}) click to toggle source

Gets configuration and usage information about anomaly detection jobs.

@option arguments [String] :job_id The ID of the jobs stats to fetch @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) Deprecated @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [List] :h Comma-separated list of column names to display @option arguments [Boolean] :help Return help information @option arguments [List] :s Comma-separated list of column names or column aliases to sort by @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-anomaly-detectors.html

# 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 = {}) click to toggle source

Gets configuration and usage information about inference trained models.

@option arguments [String] :model_id The ID of the trained models stats to fetch @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) @option arguments [Int] :from skips a number of trained models @option arguments [Int] :size specifies a max number of trained models to get @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [List] :h Comma-separated list of column names to display @option arguments [Boolean] :help Return help information @option arguments [List] :s Comma-separated list of column names or column aliases to sort by @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-trained-model.html

# 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 = {}) click to toggle source

@see www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html

# 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 = {}) click to toggle source

Gets configuration and usage information about transforms.

@option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms @option arguments [Int] :from skips a number of transform configs, defaults to 0 @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100 @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [List] :h Comma-separated list of column names to display @option arguments [Boolean] :help Return help information @option arguments [List] :s Comma-separated list of column names or column aliases to sort by @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-transforms.html

# 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