Class: DaytonaApiClient::AdminApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdminApi

Returns a new instance of AdminApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Create runner

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 26

def admin_create_runner(admin_create_runner, opts = {})
  data, _status_code, _headers = admin_create_runner_with_http_info(admin_create_runner, opts)
  data
end

#admin_create_runner_with_http_info(admin_create_runner, opts = {}) ⇒ Array<(CreateRunnerResponse, Integer, Hash)>

Create runner

Parameters:

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

    the optional parameters

Returns:

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

    CreateRunnerResponse 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
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 35

def admin_create_runner_with_http_info(admin_create_runner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_create_runner ...'
  end
  # verify the required parameter 'admin_create_runner' is set
  if @api_client.config.client_side_validation && admin_create_runner.nil?
    fail ArgumentError, "Missing the required parameter 'admin_create_runner' when calling AdminApi.admin_create_runner"
  end
  # resource path
  local_var_path = '/admin/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

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(admin_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 => :"AdminApi.admin_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: AdminApi#admin_create_runner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete runner

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 92

def admin_delete_runner(id, opts = {})
  admin_delete_runner_with_http_info(id, opts)
  nil
end

#admin_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

Returns:

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

    nil, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 101

def admin_delete_runner_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_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 AdminApi.admin_delete_runner"
  end
  # resource path
  local_var_path = '/admin/runners/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || ['bearer', 'oauth2']

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

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

Get runner by ID

Parameters:

  • id (String) —

    Runner ID

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 151

def admin_get_runner_by_id(id, opts = {})
  data, _status_code, _headers = admin_get_runner_by_id_with_http_info(id, opts)
  data
end

#admin_get_runner_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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 160

def admin_get_runner_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_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 AdminApi.admin_get_runner_by_id"
  end
  # resource path
  local_var_path = '/admin/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']

  # 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 => :"AdminApi.admin_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: AdminApi#admin_get_runner_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#admin_list_runners(opts = {}) ⇒ Array<RunnerFull>

List all runners

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :region_id (String) —

    Filter runners by region ID

Returns:



212
213
214
215
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 212

def admin_list_runners(opts = {})
  data, _status_code, _headers = admin_list_runners_with_http_info(opts)
  data
end

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

List all runners

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :region_id (String) —

    Filter runners by region ID

Returns:

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

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



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
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 221

def admin_list_runners_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_list_runners ...'
  end
  # resource path
  local_var_path = '/admin/runners'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'regionId'] = opts[:'region_id'] if !opts[:'region_id'].nil?

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

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

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

#admin_recover_sandbox(sandbox_id, opts = {}) ⇒ Sandbox

Recover sandbox from error state as an admin

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

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

    the optional parameters

Returns:



270
271
272
273
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 270

def admin_recover_sandbox(sandbox_id, opts = {})
  data, _status_code, _headers = admin_recover_sandbox_with_http_info(sandbox_id, opts)
  data
end

#admin_recover_sandbox_with_http_info(sandbox_id, opts = {}) ⇒ Array<(Sandbox, Integer, Hash)>

Recover sandbox from error state as an admin

Parameters:

  • sandbox_id (String) —

    ID of the sandbox

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

    the optional parameters

Returns:

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

    Sandbox data, response status code and response headers



279
280
281
282
283
284
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
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 279

def admin_recover_sandbox_with_http_info(sandbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_recover_sandbox ...'
  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 AdminApi.admin_recover_sandbox"
  end
  # resource path
  local_var_path = '/admin/sandbox/{sandboxId}/recover'.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] || 'Sandbox'

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

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

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

Update runner scheduling status

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


331
332
333
334
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 331

def admin_update_runner_scheduling(id, opts = {})
  admin_update_runner_scheduling_with_http_info(id, opts)
  nil
end

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

Update runner scheduling status

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/daytona_api_client/api/admin_api.rb', line 340

def admin_update_runner_scheduling_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.admin_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 AdminApi.admin_update_runner_scheduling"
  end
  # resource path
  local_var_path = '/admin/runners/{id}/scheduling'.sub('{' + 'id' + '}', CGI.escape(id.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] || ['bearer', 'oauth2']

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