Class: OpenapiClient::AlertsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/alerts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AlertsApi

Returns a new instance of AlertsApi.



19
20
21
 
# File 'lib/openapi_client/api/alerts_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_client/api/alerts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#alerts_get(opts = {}) ⇒ Array<AlertRule>

List alert rules

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/openapi_client/api/alerts_api.rb', line 25

def alerts_get(opts = {})
  data, _status_code, _headers = alerts_get_with_http_info(opts)
  data
end

#alerts_get_with_http_info(opts = {}) ⇒ Array<(Array<AlertRule>, Integer, Hash)>

List alert rules

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<AlertRule>, Integer, Hash)>) —

    Array<AlertRule> data, response status code and response headers



33
34
35
36
37
38
39
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
 
# File 'lib/openapi_client/api/alerts_api.rb', line 33

def alerts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.alerts_get ...'
  end
  # resource path
  local_var_path = '/alerts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AlertRule>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"AlertsApi.alerts_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#alerts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#alerts_id_delete(id, opts = {}) ⇒ nil

Delete alert rule

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


81
82
83
84
 
# File 'lib/openapi_client/api/alerts_api.rb', line 81

def alerts_id_delete(id, opts = {})
  alerts_id_delete_with_http_info(id, opts)
  nil
end

#alerts_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete alert rule

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/openapi_client/api/alerts_api.rb', line 90

def alerts_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.alerts_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AlertsApi.alerts_id_delete"
  end
  # resource path
  local_var_path = '/alerts/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"AlertsApi.alerts_id_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#alerts_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#alerts_id_get(id, opts = {}) ⇒ AlertRule

Get alert rule

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/openapi_client/api/alerts_api.rb', line 140

def alerts_id_get(id, opts = {})
  data, _status_code, _headers = alerts_id_get_with_http_info(id, opts)
  data
end

#alerts_id_get_with_http_info(id, opts = {}) ⇒ Array<(AlertRule, Integer, Hash)>

Get alert rule

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AlertRule, Integer, Hash)>) —

    AlertRule data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/openapi_client/api/alerts_api.rb', line 149

def alerts_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.alerts_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AlertsApi.alerts_id_get"
  end
  # resource path
  local_var_path = '/alerts/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AlertRule'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"AlertsApi.alerts_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#alerts_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#alerts_id_test_post(id, opts = {}) ⇒ nil

Test an alert rule

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


201
202
203
204
 
# File 'lib/openapi_client/api/alerts_api.rb', line 201

def alerts_id_test_post(id, opts = {})
  alerts_id_test_post_with_http_info(id, opts)
  nil
end

#alerts_id_test_post_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Test an alert rule

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/openapi_client/api/alerts_api.rb', line 210

def alerts_id_test_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.alerts_id_test_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AlertsApi.alerts_id_test_post"
  end
  # resource path
  local_var_path = '/alerts/{id}/test'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"AlertsApi.alerts_id_test_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#alerts_id_test_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#alerts_post(create_alert_request, opts = {}) ⇒ AlertRule

Create alert rule

Parameters:

  • create_alert_request (CreateAlertRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



260
261
262
263
 
# File 'lib/openapi_client/api/alerts_api.rb', line 260

def alerts_post(create_alert_request, opts = {})
  data, _status_code, _headers = alerts_post_with_http_info(create_alert_request, opts)
  data
end

#alerts_post_with_http_info(create_alert_request, opts = {}) ⇒ Array<(AlertRule, Integer, Hash)>

Create alert rule

Parameters:

  • create_alert_request (CreateAlertRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AlertRule, Integer, Hash)>) —

    AlertRule data, response status code and response headers



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/openapi_client/api/alerts_api.rb', line 269

def alerts_post_with_http_info(create_alert_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AlertsApi.alerts_post ...'
  end
  # verify the required parameter 'create_alert_request' is set
  if @api_client.config.client_side_validation && create_alert_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_alert_request' when calling AlertsApi.alerts_post"
  end
  # resource path
  local_var_path = '/alerts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_alert_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AlertRule'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"AlertsApi.alerts_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertsApi#alerts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end