Class: CloudReactorAPIClient::RunEnvironmentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudreactor_api_client/api/run_environments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RunEnvironmentsApi

Returns a new instance of RunEnvironmentsApi.



19
20
21
 
# File 'lib/cloudreactor_api_client/api/run_environments_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/cloudreactor_api_client/api/run_environments_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#run_environments_clone_create(uuid, run_environment, opts = {}) ⇒ RunEnvironment

Parameters:

  • uuid (String)
  • run_environment (RunEnvironment)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 26

def run_environments_clone_create(uuid, run_environment, opts = {})
  data, _status_code, _headers = run_environments_clone_create_with_http_info(uuid, run_environment, opts)
  data
end

#run_environments_clone_create_with_http_info(uuid, run_environment, opts = {}) ⇒ Array<(RunEnvironment, Integer, Hash)>

Returns RunEnvironment data, response status code and response headers.

Parameters:

  • uuid (String)
  • run_environment (RunEnvironment)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    RunEnvironment data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 35

def run_environments_clone_create_with_http_info(uuid, run_environment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunEnvironmentsApi.run_environments_clone_create ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RunEnvironmentsApi.run_environments_clone_create"
  end
  # verify the required parameter 'run_environment' is set
  if @api_client.config.client_side_validation && run_environment.nil?
    fail ArgumentError, "Missing the required parameter 'run_environment' when calling RunEnvironmentsApi.run_environments_clone_create"
  end
  # resource path
  local_var_path = '/run_environments/{uuid}/clone/'.sub('{' + 'uuid' + '}', CGI.escape(uuid.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(run_environment)

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

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

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

#run_environments_create(run_environment, opts = {}) ⇒ RunEnvironment

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 95

def run_environments_create(run_environment, opts = {})
  data, _status_code, _headers = run_environments_create_with_http_info(run_environment, opts)
  data
end

#run_environments_create_with_http_info(run_environment, opts = {}) ⇒ Array<(RunEnvironment, Integer, Hash)>

Returns RunEnvironment data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    RunEnvironment data, response status code and response headers



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
148
149
150
151
152
153
154
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 103

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

  # 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(run_environment)

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

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

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

#run_environments_destroy(uuid, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


159
160
161
162
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 159

def run_environments_destroy(uuid, opts = {})
  run_environments_destroy_with_http_info(uuid, opts)
  nil
end

#run_environments_destroy_with_http_info(uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
209
210
211
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 167

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

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

#run_environments_list(opts = {}) ⇒ PaginatedRunEnvironmentList

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created_by_group__id (Integer)
  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

Returns:



221
222
223
224
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 221

def run_environments_list(opts = {})
  data, _status_code, _headers = run_environments_list_with_http_info(opts)
  data
end

#run_environments_list_with_http_info(opts = {}) ⇒ Array<(PaginatedRunEnvironmentList, Integer, Hash)>

Returns PaginatedRunEnvironmentList data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created_by_group__id (Integer)
  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :search (String) —

    A search term.

Returns:

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

    PaginatedRunEnvironmentList data, response status code and response headers



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
276
277
278
279
280
281
282
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 234

def run_environments_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunEnvironmentsApi.run_environments_list ...'
  end
  # resource path
  local_var_path = '/run_environments/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'created_by_group__id'] = opts[:'created_by_group__id'] if !opts[:'created_by_group__id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # 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] || 'PaginatedRunEnvironmentList'

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

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

#run_environments_partial_update(uuid, opts = {}) ⇒ RunEnvironment

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



288
289
290
291
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 288

def run_environments_partial_update(uuid, opts = {})
  data, _status_code, _headers = run_environments_partial_update_with_http_info(uuid, opts)
  data
end

#run_environments_partial_update_with_http_info(uuid, opts = {}) ⇒ Array<(RunEnvironment, Integer, Hash)>

Returns RunEnvironment data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RunEnvironment data, response status code and response headers



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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 297

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

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

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

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

#run_environments_retrieve(uuid, opts = {}) ⇒ RunEnvironment

Parameters:

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

    the optional parameters

Returns:



353
354
355
356
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 353

def run_environments_retrieve(uuid, opts = {})
  data, _status_code, _headers = run_environments_retrieve_with_http_info(uuid, opts)
  data
end

#run_environments_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(RunEnvironment, Integer, Hash)>

Returns RunEnvironment data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    RunEnvironment data, response status code and response headers



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 361

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

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

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

#run_environments_update(uuid, run_environment, opts = {}) ⇒ RunEnvironment

Parameters:

  • uuid (String)
  • run_environment (RunEnvironment)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 413

def run_environments_update(uuid, run_environment, opts = {})
  data, _status_code, _headers = run_environments_update_with_http_info(uuid, run_environment, opts)
  data
end

#run_environments_update_with_http_info(uuid, run_environment, opts = {}) ⇒ Array<(RunEnvironment, Integer, Hash)>

Returns RunEnvironment data, response status code and response headers.

Parameters:

  • uuid (String)
  • run_environment (RunEnvironment)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    RunEnvironment data, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/cloudreactor_api_client/api/run_environments_api.rb', line 422

def run_environments_update_with_http_info(uuid, run_environment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunEnvironmentsApi.run_environments_update ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling RunEnvironmentsApi.run_environments_update"
  end
  # verify the required parameter 'run_environment' is set
  if @api_client.config.client_side_validation && run_environment.nil?
    fail ArgumentError, "Missing the required parameter 'run_environment' when calling RunEnvironmentsApi.run_environments_update"
  end
  # resource path
  local_var_path = '/run_environments/{uuid}/'.sub('{' + 'uuid' + '}', CGI.escape(uuid.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(run_environment)

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

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

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