Method: Elasticsearch::API::MachineLearning::Actions#get_model_snapshots

Defined in:
lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb

#get_model_snapshots(arguments = {}) ⇒ Object

Retrieves information about model snapshots.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :job_id (String) —

    The ID of the job to fetch

  • :snapshot_id (String) —

    The ID of the snapshot to fetch

  • :from (Integer) —

    Skips a number of documents

  • :size (Integer) —

    The default number of documents returned in queries as a string.

  • :start (Date) —

    The filter ‘start’ query parameter

  • :end (Date) —

    The filter ‘end’ query parameter

  • :sort (String) —

    Name of the field to sort on

  • :desc (Boolean) —

    True if the results should be sorted in descending order

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    Model snapshot selection criteria

Raises:

  • (ArgumentError)

See Also:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb', line 40

def get_model_snapshots(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "ml.get_model_snapshots" }

  defined_params = [:job_id, :snapshot_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _job_id = arguments.delete(:job_id)

  _snapshot_id = arguments.delete(:snapshot_id)

  method = if body
             Elasticsearch::API::HTTP_POST
           else
             Elasticsearch::API::HTTP_GET
           end

  path   = if _job_id && _snapshot_id
             "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}"
           else
             "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots"
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end