Class: Athenian::EventsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/api/events_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.



16
17
18
 
# File 'lib/athenian/api/events_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/athenian/api/events_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#clear_precomputed_events(opts = {}) ⇒ Object

Reset the precomputed data related to the pushed events.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


23
24
25
26
 
# File 'lib/athenian/api/events_api.rb', line 23

def clear_precomputed_events(opts = {})
  data, _status_code, _headers = clear_precomputed_events_with_http_info(opts)
  data
end

#clear_precomputed_events_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Reset the precomputed data related to the pushed events.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



32
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
76
77
78
79
 
# File 'lib/athenian/api/events_api.rb', line 32

def clear_precomputed_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.clear_precomputed_events ...'
  end
  # resource path
  local_var_path = '/events/clear_cache'

  # 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'])
  # 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(opts[:'body'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"EventsApi.clear_precomputed_events",
    :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: EventsApi#clear_precomputed_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deployment_labels(name, opts = {}) ⇒ GetDeploymentLabels200Response

Retrieve the labels associated with the deployment.

Parameters:

  • name (String) —

    Name of the deployment.

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

    the optional parameters

Returns:



85
86
87
88
 
# File 'lib/athenian/api/events_api.rb', line 85

def get_deployment_labels(name, opts = {})
  data, _status_code, _headers = get_deployment_labels_with_http_info(name, opts)
  data
end

#get_deployment_labels_with_http_info(name, opts = {}) ⇒ Array<(GetDeploymentLabels200Response, Integer, Hash)>

Retrieve the labels associated with the deployment.

Parameters:

  • name (String) —

    Name of the deployment.

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

    the optional parameters

Returns:



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
135
136
137
138
139
140
 
# File 'lib/athenian/api/events_api.rb', line 94

def get_deployment_labels_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.get_deployment_labels ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling EventsApi.get_deployment_labels"
  end
  # resource path
  local_var_path = '/events/deployment/{name}/labels'.sub('{' + 'name' + '}', CGI.escape(name.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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"EventsApi.get_deployment_labels",
    :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: EventsApi#get_deployment_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_deployment_labels(name, opts = {}) ⇒ GetDeploymentLabels200Response

Modify the labels for the deployment applying the given instructions.

Parameters:

  • name (String) —

    Name of the deployment.

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

    the optional parameters

Options Hash (opts):

Returns:



147
148
149
150
 
# File 'lib/athenian/api/events_api.rb', line 147

def modify_deployment_labels(name, opts = {})
  data, _status_code, _headers = modify_deployment_labels_with_http_info(name, opts)
  data
end

#modify_deployment_labels_with_http_info(name, opts = {}) ⇒ Array<(GetDeploymentLabels200Response, Integer, Hash)>

Modify the labels for the deployment applying the given instructions.

Parameters:

  • name (String) —

    Name of the deployment.

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

    the optional parameters

Options Hash (opts):

Returns:



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
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/athenian/api/events_api.rb', line 157

def modify_deployment_labels_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.modify_deployment_labels ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling EventsApi.modify_deployment_labels"
  end
  # resource path
  local_var_path = '/events/deployment/{name}/labels'.sub('{' + 'name' + '}', CGI.escape(name.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'])
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"EventsApi.modify_deployment_labels",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#modify_deployment_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#notify_deployments(opts = {}) ⇒ NotifyDeployments200Response

Notify about new deployments.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



214
215
216
217
 
# File 'lib/athenian/api/events_api.rb', line 214

def notify_deployments(opts = {})
  data, _status_code, _headers = notify_deployments_with_http_info(opts)
  data
end

#notify_deployments_with_http_info(opts = {}) ⇒ Array<(NotifyDeployments200Response, Integer, Hash)>

Notify about new deployments.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/athenian/api/events_api.rb', line 223

def notify_deployments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.notify_deployments ...'
  end
  # resource path
  local_var_path = '/events/deployments'

  # 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'])
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"EventsApi.notify_deployments",
    :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: EventsApi#notify_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#notify_releases(opts = {}) ⇒ Array<ReleaseNotificationStatus>

Notify about new releases. The release settings must be set to "event".

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



276
277
278
279
 
# File 'lib/athenian/api/events_api.rb', line 276

def notify_releases(opts = {})
  data, _status_code, _headers = notify_releases_with_http_info(opts)
  data
end

#notify_releases_with_http_info(opts = {}) ⇒ Array<(Array<ReleaseNotificationStatus>, Integer, Hash)>

Notify about new releases. The release settings must be set to &quot;event&quot;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

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



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
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/athenian/api/events_api.rb', line 285

def notify_releases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.notify_releases ...'
  end
  # resource path
  local_var_path = '/events/releases'

  # 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'])
  # 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(opts[:'body'])

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

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

  new_options = opts.merge(
    :operation => :"EventsApi.notify_releases",
    :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: EventsApi#notify_releases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end