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 = {}) ⇒ nil

Create runner

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def create_runner(create_runner, opts = {})
  create_runner_with_http_info(create_runner, opts)
  nil
end

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

Create runner

Parameters:

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

    the optional parameters

Returns:

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

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

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 '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(create_runner)

  # return_type
  return_type = opts[:debug_return_type]

  # 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

#get_info_for_authenticated_runner(opts = {}) ⇒ Runner

Get info for authenticated runner

Parameters:

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 89

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<(Runner, Integer, Hash)>

Get info for authenticated runner

Parameters:

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

    the optional parameters

Returns:

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

    Runner data, response status code and response headers



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 97

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] || 'Runner'

  # 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_sandbox_id(sandbox_id, opts = {}) ⇒ Runner

Get runner by sandbox ID

Parameters:

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 145

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<(Runner, Integer, Hash)>

Get runner by sandbox ID

Parameters:

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

    the optional parameters

Returns:

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

    Runner data, response status code and response headers



154
155
156
157
158
159
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
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 154

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] || 'Runner'

  # 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_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:



206
207
208
209
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 206

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



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

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 = {}) ⇒ nil

List all runners

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


267
268
269
270
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 267

def list_runners(opts = {})
  list_runners_with_http_info(opts)
  nil
end

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

List all runners

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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] || {}

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

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

Update runner scheduling status

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


321
322
323
324
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 321

def update_runner_scheduling(id, opts = {})
  update_runner_scheduling_with_http_info(id, opts)
  nil
end

#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



330
331
332
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
368
369
370
371
372
373
374
 
# File 'lib/daytona_api_client/api/runners_api.rb', line 330

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] || {}

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