Class: SwaggerClient::V2CanaryControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/api/v2_canary_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ V2CanaryControllerApi

Returns a new instance of V2CanaryControllerApi.



19
20
21
 
# File 'lib/swagger_client/api/v2_canary_controller_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/swagger_client/api/v2_canary_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_canary_result_using_get(canary_config_id, canary_execution_id, opts = {}) ⇒ Object

Retrieve a canary result

Parameters:

  • canary_config_id —

    canaryConfigId

  • canary_execution_id —

    canaryExecutionId

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

    the optional parameters

Options Hash (opts):

  • :storage_account_name (String) —

    storageAccountName

Returns:

  • (Object) 


28
29
30
31
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 28

def get_canary_result_using_get(canary_config_id, canary_execution_id, opts = {})
  data, _status_code, _headers = get_canary_result_using_get_with_http_info(canary_config_id, canary_execution_id, opts)
  data
end

#get_canary_result_using_get_with_http_info(canary_config_id, canary_execution_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Retrieve a canary result

Parameters:

  • canary_config_id —

    canaryConfigId

  • canary_execution_id —

    canaryExecutionId

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

    the optional parameters

Options Hash (opts):

  • :storage_account_name (String) —

    storageAccountName

Returns:

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

    Object data, response status code and response headers



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
80
81
82
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 39

def get_canary_result_using_get_with_http_info(canary_config_id, canary_execution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2CanaryControllerApi.get_canary_result_using_get ...'
  end
  # verify the required parameter 'canary_config_id' is set
  if @api_client.config.client_side_validation && canary_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'canary_config_id' when calling V2CanaryControllerApi.get_canary_result_using_get"
  end
  # verify the required parameter 'canary_execution_id' is set
  if @api_client.config.client_side_validation && canary_execution_id.nil?
    fail ArgumentError, "Missing the required parameter 'canary_execution_id' when calling V2CanaryControllerApi.get_canary_result_using_get"
  end
  # resource path
  local_var_path = '/v2/canaries/canary/{canaryConfigId}/{canaryExecutionId}'.sub('{' + 'canaryConfigId' + '}', canary_config_id.to_s).sub('{' + 'canaryExecutionId' + '}', canary_execution_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageAccountName'] = opts[:'storage_account_name'] if !opts[:'storage_account_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2CanaryControllerApi#get_canary_result_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_canary_results_by_application_using_get(application, limit, opts = {}) ⇒ Array<Object>

Retrieve a list of an application’s canary results

Parameters:

  • application —

    application

  • limit —

    limit

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

    the optional parameters

Options Hash (opts):

  • :statuses (String) —

    Comma-separated list of statuses, e.g.: RUNNING, SUCCEEDED, TERMINAL

  • :storage_account_name (String) —

    storageAccountName

Returns:

  • (Array<Object>) 


90
91
92
93
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 90

def get_canary_results_by_application_using_get(application, limit, opts = {})
  data, _status_code, _headers = get_canary_results_by_application_using_get_with_http_info(application, limit, opts)
  data
end

#get_canary_results_by_application_using_get_with_http_info(application, limit, opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Retrieve a list of an application&#39;s canary results

Parameters:

  • application —

    application

  • limit —

    limit

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

    the optional parameters

Options Hash (opts):

  • :statuses (String) —

    Comma-separated list of statuses, e.g.: RUNNING, SUCCEEDED, TERMINAL

  • :storage_account_name (String) —

    storageAccountName

Returns:

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

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



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
141
142
143
144
145
146
147
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 102

def get_canary_results_by_application_using_get_with_http_info(application, limit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2CanaryControllerApi.get_canary_results_by_application_using_get ...'
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling V2CanaryControllerApi.get_canary_results_by_application_using_get"
  end
  # verify the required parameter 'limit' is set
  if @api_client.config.client_side_validation && limit.nil?
    fail ArgumentError, "Missing the required parameter 'limit' when calling V2CanaryControllerApi.get_canary_results_by_application_using_get"
  end
  # resource path
  local_var_path = '/v2/canaries/{application}/executions'.sub('{' + 'application' + '}', application.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = limit
  query_params[:'statuses'] = opts[:'statuses'] if !opts[:'statuses'].nil?
  query_params[:'storageAccountName'] = opts[:'storage_account_name'] if !opts[:'storage_account_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2CanaryControllerApi#get_canary_results_by_application_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_metric_set_pair_list_using_get(metric_set_pair_list_id, opts = {}) ⇒ Array<Object>

Retrieve a metric set pair list

Parameters:

  • metric_set_pair_list_id —

    metricSetPairListId

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

    the optional parameters

Options Hash (opts):

  • :storage_account_name (String) —

    storageAccountName

Returns:

  • (Array<Object>) 


153
154
155
156
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 153

def get_metric_set_pair_list_using_get(metric_set_pair_list_id, opts = {})
  data, _status_code, _headers = get_metric_set_pair_list_using_get_with_http_info(metric_set_pair_list_id, opts)
  data
end

#get_metric_set_pair_list_using_get_with_http_info(metric_set_pair_list_id, opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Retrieve a metric set pair list

Parameters:

  • metric_set_pair_list_id —

    metricSetPairListId

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

    the optional parameters

Options Hash (opts):

  • :storage_account_name (String) —

    storageAccountName

Returns:

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

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



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
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 163

def get_metric_set_pair_list_using_get_with_http_info(metric_set_pair_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2CanaryControllerApi.get_metric_set_pair_list_using_get ...'
  end
  # verify the required parameter 'metric_set_pair_list_id' is set
  if @api_client.config.client_side_validation && metric_set_pair_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_set_pair_list_id' when calling V2CanaryControllerApi.get_metric_set_pair_list_using_get"
  end
  # resource path
  local_var_path = '/v2/canaries/metricSetPairList/{metricSetPairListId}'.sub('{' + 'metricSetPairListId' + '}', metric_set_pair_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'storageAccountName'] = opts[:'storage_account_name'] if !opts[:'storage_account_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2CanaryControllerApi#get_metric_set_pair_list_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#initiate_canary_using_post(canary_config_id, execution_request, opts = {}) ⇒ Object

Start a canary execution

Parameters:

  • canary_config_id —

    canaryConfigId

  • execution_request —

    executionRequest

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

    the optional parameters

Options Hash (opts):

  • :application (String) —

    application

  • :parent_pipeline_execution_id (String) —

    parentPipelineExecutionId

  • :metrics_account_name (String) —

    metricsAccountName

  • :storage_account_name (String) —

    storageAccountName

  • :configuration_account_name (String) —

    configurationAccountName

Returns:

  • (Object) 


213
214
215
216
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 213

def initiate_canary_using_post(canary_config_id, execution_request, opts = {})
  data, _status_code, _headers = initiate_canary_using_post_with_http_info(canary_config_id, execution_request, opts)
  data
end

#initiate_canary_using_post_with_http_info(canary_config_id, execution_request, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Start a canary execution

Parameters:

  • canary_config_id —

    canaryConfigId

  • execution_request —

    executionRequest

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

    the optional parameters

Options Hash (opts):

  • :application (String) —

    application

  • :parent_pipeline_execution_id (String) —

    parentPipelineExecutionId

  • :metrics_account_name (String) —

    metricsAccountName

  • :storage_account_name (String) —

    storageAccountName

  • :configuration_account_name (String) —

    configurationAccountName

Returns:

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

    Object data, response status code and response headers



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
271
272
273
274
275
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 228

def initiate_canary_using_post_with_http_info(canary_config_id, execution_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2CanaryControllerApi.initiate_canary_using_post ...'
  end
  # verify the required parameter 'canary_config_id' is set
  if @api_client.config.client_side_validation && canary_config_id.nil?
    fail ArgumentError, "Missing the required parameter 'canary_config_id' when calling V2CanaryControllerApi.initiate_canary_using_post"
  end
  # verify the required parameter 'execution_request' is set
  if @api_client.config.client_side_validation && execution_request.nil?
    fail ArgumentError, "Missing the required parameter 'execution_request' when calling V2CanaryControllerApi.initiate_canary_using_post"
  end
  # resource path
  local_var_path = '/v2/canaries/canary/{canaryConfigId}'.sub('{' + 'canaryConfigId' + '}', canary_config_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'application'] = opts[:'application'] if !opts[:'application'].nil?
  query_params[:'parentPipelineExecutionId'] = opts[:'parent_pipeline_execution_id'] if !opts[:'parent_pipeline_execution_id'].nil?
  query_params[:'metricsAccountName'] = opts[:'metrics_account_name'] if !opts[:'metrics_account_name'].nil?
  query_params[:'storageAccountName'] = opts[:'storage_account_name'] if !opts[:'storage_account_name'].nil?
  query_params[:'configurationAccountName'] = opts[:'configuration_account_name'] if !opts[:'configuration_account_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(execution_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2CanaryControllerApi#initiate_canary_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_credentials_using_get(opts = {}) ⇒ Array<Object>

Retrieve a list of configured Kayenta accounts

Parameters:

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

    the optional parameters

Returns:

  • (Array<Object>) 


279
280
281
282
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 279

def list_credentials_using_get(opts = {})
  data, _status_code, _headers = list_credentials_using_get_with_http_info(opts)
  data
end

#list_credentials_using_get_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Retrieve a list of configured Kayenta accounts

Parameters:

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

    the optional parameters

Returns:

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

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



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
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 287

def list_credentials_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2CanaryControllerApi.list_credentials_using_get ...'
  end
  # resource path
  local_var_path = '/v2/canaries/credentials'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2CanaryControllerApi#list_credentials_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_judges_using_get(opts = {}) ⇒ Array<Object>

Retrieve a list of all configured canary judges

Parameters:

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

    the optional parameters

Returns:

  • (Array<Object>) 


325
326
327
328
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 325

def list_judges_using_get(opts = {})
  data, _status_code, _headers = list_judges_using_get_with_http_info(opts)
  data
end

#list_judges_using_get_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Retrieve a list of all configured canary judges

Parameters:

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

    the optional parameters

Returns:

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

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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 333

def list_judges_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2CanaryControllerApi.list_judges_using_get ...'
  end
  # resource path
  local_var_path = '/v2/canaries/judges'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2CanaryControllerApi#list_judges_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_metrics_service_metadata_using_get(opts = {}) ⇒ Array<Object>

Retrieve a list of descriptors for use in populating the canary config ui

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

  • :metrics_account_name (String) —

    metricsAccountName

Returns:

  • (Array<Object>) 


373
374
375
376
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 373

def list_metrics_service_metadata_using_get(opts = {})
  data, _status_code, _headers = list_metrics_service_metadata_using_get_with_http_info(opts)
  data
end

#list_metrics_service_metadata_using_get_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Retrieve a list of descriptors for use in populating the canary config ui

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

  • :metrics_account_name (String) —

    metricsAccountName

Returns:

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

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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/swagger_client/api/v2_canary_controller_api.rb', line 383

def list_metrics_service_metadata_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V2CanaryControllerApi.list_metrics_service_metadata_using_get ...'
  end
  # resource path
  local_var_path = '/v2/canaries/metadata/metricsService'

  # query parameters
  query_params = {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'metricsAccountName'] = opts[:'metrics_account_name'] if !opts[:'metrics_account_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V2CanaryControllerApi#list_metrics_service_metadata_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end