Class: DeploymentTrackerClient::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/deployment-tracker-client/api/default_api.rb

Class Method Summary collapse

Class Method Details

.config(opts = {}) ⇒ ObjectResponse

Return the current application configuration

Parameters:

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

    the optional parameters

Returns:



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 12

def self.config(opts = {})
  

  # resource path
  path = "/config".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = []
  response =SwaggerClient::Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = ObjectResponse.new() and obj.build_from_hash(response)
end

.get_all_servers(offset, limit, opts = {}) ⇒ array[string]

Return a list of all servers that have been deployed to

Parameters:

  • offset —

    Which result to start with

  • limit —

    Number of results to return

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

    the optional parameters

Returns:

  • (array[string]) 


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
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 392

def self.get_all_servers(offset, limit, opts = {})
  
  # verify the required parameter 'offset' is set
  raise "Missing the required parameter 'offset' when calling get_all_servers" if offset.nil?
  
  # verify the required parameter 'limit' is set
  raise "Missing the required parameter 'limit' when calling get_all_servers" if limit.nil?
  

  # resource path
  path = "/v1/servers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'offset'] = offset
  query_params[:'limit'] = limit

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = []
  response =SwaggerClient::Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  response.map {|response| obj = string.new() and obj.build_from_hash(response) }
end

.get_deployment(id, opts = {}) ⇒ Deployment

Get a deployment

Parameters:

  • id —

    Unique Identifier (UUID) of the deployment to retrieve

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

    the optional parameters

Returns:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 131

def self.get_deployment(id, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling get_deployment" if id.nil?
  

  # resource path
  path = "/v1/deployments/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = []
  response =SwaggerClient::Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = Deployment.new() and obj.build_from_hash(response)
end

.get_deployments(offset, limit, opts = {}) ⇒ array[Deployment]

Get the list of most recently completed deployments

Parameters:

  • offset —

    Which result to start with

  • limit —

    Number of results to return

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

    the optional parameters

Returns:



86
87
88
89
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
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 86

def self.get_deployments(offset, limit, opts = {})
  
  # verify the required parameter 'offset' is set
  raise "Missing the required parameter 'offset' when calling get_deployments" if offset.nil?
  
  # verify the required parameter 'limit' is set
  raise "Missing the required parameter 'limit' when calling get_deployments" if limit.nil?
  

  # resource path
  path = "/v1/deployments".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'offset'] = offset
  query_params[:'limit'] = limit

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = []
  response =SwaggerClient::Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  response.map {|response| obj = Deployment.new() and obj.build_from_hash(response) }
end

.get_server_by_hostname(hostname, offset, limit, opts = {}) ⇒ array[Server]

Return a list of all servers that have been deployed to

Parameters:

  • hostname —

    The hostname for the server

  • offset —

    Which result to start with

  • limit —

    Number of results to return

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

    the optional parameters

Returns:



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
478
479
480
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 439

def self.get_server_by_hostname(hostname, offset, limit, opts = {})
  
  # verify the required parameter 'hostname' is set
  raise "Missing the required parameter 'hostname' when calling get_server_by_hostname" if hostname.nil?
  
  # verify the required parameter 'offset' is set
  raise "Missing the required parameter 'offset' when calling get_server_by_hostname" if offset.nil?
  
  # verify the required parameter 'limit' is set
  raise "Missing the required parameter 'limit' when calling get_server_by_hostname" if limit.nil?
  

  # resource path
  path = "/v1/servers/{hostname}".sub('{format}','json').sub('{' + 'hostname' + '}', hostname.to_s)

  # query parameters
  query_params = {}
  query_params[:'offset'] = offset
  query_params[:'limit'] = limit

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = []
  response =SwaggerClient::Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  response.map {|response| obj = Server.new() and obj.build_from_hash(response) }
end

.healthcheck(opts = {}) ⇒ ObjectResponse

Run a health check and return the test results

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 48

def self.healthcheck(opts = {})
  

  # resource path
  path = "/healthcheck".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = []
  response =SwaggerClient::Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = ObjectResponse.new() and obj.build_from_hash(response)
end

.post_deployment(id, body, opts = {}) ⇒ nil

Record the start of a new deployment

Parameters:

  • id —

    Unique Identifier (UUID) of the deployment that is starting

  • body —

    The Deployment object to be created

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

    the optional parameters

Returns:

  • (nil) 


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
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 216

def self.post_deployment(id, body, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling post_deployment" if id.nil?
  
  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling post_deployment" if body.nil?
  

  # resource path
  path = "/v1/deployments/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['text/plain']
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body =SwaggerClient::Swagger::Request.object_to_http_body(body)
  

  auth_names = []
 SwaggerClient::Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end

.post_logs(id, body, opts = {}) ⇒ nil

Record a log message associated with a deployment

Parameters:

  • id —

    Unique Identifier (UUID) of the deployment that is starting

  • body —

    The log message to be recorded

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

    the optional parameters

Returns:

  • (nil) 


260
261
262
263
264
265
266
267
268
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
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 260

def self.post_logs(id, body, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling post_logs" if id.nil?
  
  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling post_logs" if body.nil?
  

  # resource path
  path = "/v1/deployments/{id}/logs".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['text/plain']
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body =SwaggerClient::Swagger::Request.object_to_http_body(body)
  

  auth_names = []
 SwaggerClient::Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end

.post_server(id, body, opts = {}) ⇒ nil

Record the start of a deployment to a server

Parameters:

  • id —

    Unique Identifier (UUID) of the deployment that is starting

  • body —

    The server on which the deployment is starting

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

    the optional parameters

Returns:

  • (nil) 


348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 348

def self.post_server(id, body, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling post_server" if id.nil?
  
  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling post_server" if body.nil?
  

  # resource path
  path = "/v1/deployments/{id}/servers".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['text/plain']
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body =SwaggerClient::Swagger::Request.object_to_http_body(body)
  

  auth_names = []
 SwaggerClient::Swagger::Request.new(:POST, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end

.put_deployment(id, body, opts = {}) ⇒ nil

Record the completion of a new deployment

Parameters:

  • id —

    Unique Identifier (UUID) of the deployment that has completed

  • body —

    The Deployment object to be updated

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

    the optional parameters

Returns:

  • (nil) 


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/deployment-tracker-client/api/default_api.rb', line 172

def self.put_deployment(id, body, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling put_deployment" if id.nil?
  
  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling put_deployment" if body.nil?
  

  # resource path
  path = "/v1/deployments/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['text/plain']
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body =SwaggerClient::Swagger::Request.object_to_http_body(body)
  

  auth_names = []
 SwaggerClient::Swagger::Request.new(:PUT, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end

.put_server(id, body, opts = {}) ⇒ nil

Record the completion of a deployment to a server

Parameters:

  • id —

    Unique Identifier (UUID) of the deployment that has completed

  • body —

    The server on which the deployment has completed

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

    the optional parameters

Returns:

  • (nil) 


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
 
# File 'lib/deployment-tracker-client/api/default_api.rb', line 304

def self.put_server(id, body, opts = {})
  
  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling put_server" if id.nil?
  
  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling put_server" if body.nil?
  

  # resource path
  path = "/v1/deployments/{id}/servers".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['text/plain']
  _header_accept_result =SwaggerClient::Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] =SwaggerClient::Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body =SwaggerClient::Swagger::Request.object_to_http_body(body)
  

  auth_names = []
 SwaggerClient::Swagger::Request.new(:PUT, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end