Class: DaytonaApiClient::RunnersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/daytona_api_client/api/runners_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RunnersApi

Returns a new instance of RunnersApi.



19
20
21
 
# File 'lib/daytona_api_client/api/runners_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/daytona_api_client/api/runners_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_runner(create_runner, opts = {}) ⇒ CreateRunnerResponse

Create runner

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



27
28
29
30
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 27

def create_runner(create_runner, opts = {})
  data, _status_code, _headers = create_runner_with_http_info(create_runner, opts)
  data
end

#create_runner_with_http_info(create_runner, opts = {}) ⇒ Array<(CreateRunnerResponse, Integer, Hash)>

Create runner

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

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

    CreateRunnerResponse data, response status code and response headers



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
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 37

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

  # 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
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

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

Delete runner

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 96

def delete_runner(id, opts = {})
  delete_runner_with_http_info(id, opts)
  nil
end

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

Delete runner

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 106

def delete_runner_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.delete_runner ...'
  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 RunnersApi.delete_runner"
  end
  # resource path
  local_var_path = '/runners/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

  # 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] || ['bearer', 'oauth2']

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

#get_info_for_authenticated_runner(opts = {}) ⇒ RunnerFull

Get info for authenticated runner

Parameters:

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 156

def get_info_for_authenticated_runner(opts = {})
  data, _status_code, _headers = get_info_for_authenticated_runner_with_http_info(opts)
  data
end

#get_info_for_authenticated_runner_with_http_info(opts = {}) ⇒ Array<(RunnerFull, Integer, Hash)>

Get info for authenticated runner

Parameters:

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

    the optional parameters

Returns:

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

    RunnerFull data, response status code and response headers



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
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 164

def get_info_for_authenticated_runner_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.get_info_for_authenticated_runner ...'
  end
  # resource path
  local_var_path = '/runners/me'

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#get_runner_by_id(id, opts = {}) ⇒ Runner

Get runner by ID

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



213
214
215
216
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 213

def get_runner_by_id(id, opts = {})
  data, _status_code, _headers = get_runner_by_id_with_http_info(id, opts)
  data
end

#get_runner_by_id_with_http_info(id, opts = {}) ⇒ Array<(Runner, Integer, Hash)>

Get runner by ID

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

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

    Runner data, response status code and response headers



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/daytona_api_client/api/runners_api.rb', line 223

def get_runner_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.get_runner_by_id ...'
  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 RunnersApi.get_runner_by_id"
  end
  # resource path
  local_var_path = '/runners/{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']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#get_runner_by_sandbox_id(sandbox_id, opts = {}) ⇒ RunnerFull

Get runner by sandbox ID

Parameters:

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

    the optional parameters

Returns:



276
277
278
279
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 276

def get_runner_by_sandbox_id(sandbox_id, opts = {})
  data, _status_code, _headers = get_runner_by_sandbox_id_with_http_info(sandbox_id, opts)
  data
end

#get_runner_by_sandbox_id_with_http_info(sandbox_id, opts = {}) ⇒ Array<(RunnerFull, Integer, Hash)>

Get runner by sandbox ID

Parameters:

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

    the optional parameters

Returns:

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

    RunnerFull 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
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 285

def get_runner_by_sandbox_id_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.get_runner_by_sandbox_id ...'
  end
  # verify the required parameter 'sandbox_id' is set
  if @api_client.config.client_side_validation && sandbox_id.nil?
    fail ArgumentError, "Missing the required parameter 'sandbox_id' when calling RunnersApi.get_runner_by_sandbox_id"
  end
  # resource path
  local_var_path = '/runners/by-sandbox/{sandboxId}'.sub('{' + 'sandboxId' + '}', CGI.escape(sandbox_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] || 'RunnerFull'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#get_runner_full_by_id(id, opts = {}) ⇒ RunnerFull

Get runner by ID

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Returns:



337
338
339
340
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 337

def get_runner_full_by_id(id, opts = {})
  data, _status_code, _headers = get_runner_full_by_id_with_http_info(id, opts)
  data
end

#get_runner_full_by_id_with_http_info(id, opts = {}) ⇒ Array<(RunnerFull, Integer, Hash)>

Get runner by ID

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Returns:

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

    RunnerFull data, response status code and response headers



346
347
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
385
386
387
388
389
390
391
392
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 346

def get_runner_full_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.get_runner_full_by_id ...'
  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 RunnersApi.get_runner_full_by_id"
  end
  # resource path
  local_var_path = '/runners/{id}/full'.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] || 'RunnerFull'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#get_runners_by_snapshot_ref(ref, opts = {}) ⇒ Array<RunnerSnapshotDto>

Get runners by snapshot ref

Parameters:

  • ref (String) —

    Snapshot ref

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

    the optional parameters

Returns:



398
399
400
401
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 398

def get_runners_by_snapshot_ref(ref, opts = {})
  data, _status_code, _headers = get_runners_by_snapshot_ref_with_http_info(ref, opts)
  data
end

#get_runners_by_snapshot_ref_with_http_info(ref, opts = {}) ⇒ Array<(Array<RunnerSnapshotDto>, Integer, Hash)>

Get runners by snapshot ref

Parameters:

  • ref (String) —

    Snapshot ref

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

    the optional parameters

Returns:

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

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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
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
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 407

def get_runners_by_snapshot_ref_with_http_info(ref, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.get_runners_by_snapshot_ref ...'
  end
  # verify the required parameter 'ref' is set
  if @api_client.config.client_side_validation && ref.nil?
    fail ArgumentError, "Missing the required parameter 'ref' when calling RunnersApi.get_runners_by_snapshot_ref"
  end
  # resource path
  local_var_path = '/runners/by-snapshot-ref'

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

  # 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<RunnerSnapshotDto>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#list_runners(opts = {}) ⇒ Array<Runner>

List all runners

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



460
461
462
463
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 460

def list_runners(opts = {})
  data, _status_code, _headers = list_runners_with_http_info(opts)
  data
end

#list_runners_with_http_info(opts = {}) ⇒ Array<(Array<Runner>, Integer, Hash)>

List all runners

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

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

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



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 469

def list_runners_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.list_runners ...'
  end
  # resource path
  local_var_path = '/runners'

  # 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']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#runner_healthcheck(runner_healthcheck, opts = {}) ⇒ nil

Runner healthcheck Endpoint for version 2 runners to send healthcheck and metrics. Updates lastChecked timestamp and runner metrics.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


519
520
521
522
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 519

def runner_healthcheck(runner_healthcheck, opts = {})
  runner_healthcheck_with_http_info(runner_healthcheck, opts)
  nil
end

#runner_healthcheck_with_http_info(runner_healthcheck, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Runner healthcheck Endpoint for version 2 runners to send healthcheck and metrics. Updates lastChecked timestamp and runner metrics.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 529

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(runner_healthcheck)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#update_runner_draining(id, opts = {}) ⇒ Runner

Update runner draining status

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



585
586
587
588
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 585

def update_runner_draining(id, opts = {})
  data, _status_code, _headers = update_runner_draining_with_http_info(id, opts)
  data
end

#update_runner_draining_with_http_info(id, opts = {}) ⇒ Array<(Runner, Integer, Hash)>

Update runner draining status

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

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

    Runner data, response status code and response headers



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 595

def update_runner_draining_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.update_runner_draining ...'
  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 RunnersApi.update_runner_draining"
  end
  # resource path
  local_var_path = '/runners/{id}/draining'.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']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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

#update_runner_scheduling(id, opts = {}) ⇒ Runner

Update runner scheduling status

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:



649
650
651
652
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 649

def update_runner_scheduling(id, opts = {})
  data, _status_code, _headers = update_runner_scheduling_with_http_info(id, opts)
  data
end

#update_runner_scheduling_with_http_info(id, opts = {}) ⇒ Array<(Runner, Integer, Hash)>

Update runner scheduling status

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Options Hash (opts):

  • :x_daytona_organization_id (String) —

    Use with JWT to specify the organization ID

Returns:

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

    Runner data, response status code and response headers



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 659

def update_runner_scheduling_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RunnersApi.update_runner_scheduling ...'
  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 RunnersApi.update_runner_scheduling"
  end
  # resource path
  local_var_path = '/runners/{id}/scheduling'.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']
  header_params[:'X-Daytona-Organization-ID'] = opts[:'x_daytona_organization_id'] if !opts[:'x_daytona_organization_id'].nil?

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer', 'oauth2']

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