Class: Vellum::AsyncContainerImagesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/container_images/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::AsyncContainerImagesClient

Parameters:



270
271
272
 
# File 'lib/vellum_ai/container_images/client.rb', line 270

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::AsyncRequestClient (readonly)

Returns:



265
266
267
 
# File 'lib/vellum_ai/container_images/client.rb', line 265

def request_client
  @request_client
end

Instance Method Details

#create_container_image(name:, packages:, tag:, user_script: nil, is_hotswappable: nil, server_version: nil, request_options: nil) ⇒ Object

)



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/vellum_ai/container_images/client.rb', line 335

def create_container_image(name:, packages:, tag:, user_script: nil, is_hotswappable: nil, server_version: nil, request_options: nil)
  Async do
    response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), name: name, packages: packages, tag: tag, user_script: user_script, is_hotswappable: is_hotswappable, server_version: server_version }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images"
end
    Vellum::ContainerImageRead.from_json(json_object: response.body)
  end
end

#docker_service_token(request_options: nil) ⇒ Object

api.container_images.docker_service_token



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
 
# File 'lib/vellum_ai/container_images/client.rb', line 454

def docker_service_token(request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images/docker-service-token"
end
    Vellum::DockerServiceToken.from_json(json_object: response.body)
  end
end

#list(limit: nil, offset: nil, ordering: nil, request_options: nil) ⇒ Object

api.container_images.list



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/vellum_ai/container_images/client.rb', line 287

def list(limit: nil, offset: nil, ordering: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images"
end
    Vellum::PaginatedContainerImageReadList.from_json(json_object: response.body)
  end
end

#push_container_image(name:, sha:, tags:, force: nil, request_options: nil) ⇒ Object

)



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/vellum_ai/container_images/client.rb', line 497

def push_container_image(name:, sha:, tags:, force: nil, request_options: nil)
  Async do
    response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), name: name, sha: sha, tags: tags, force: force }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images/push"
end
    Vellum::ContainerImageRead.from_json(json_object: response.body)
  end
end

#retrieve(id:, request_options: nil) ⇒ Object

api.container_images.retrieve(id: "id")



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
 
# File 'lib/vellum_ai/container_images/client.rb', line 371

def retrieve(id:, request_options: nil)
  Async do
    response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images/#{id}"
end
    Vellum::ContainerImageRead.from_json(json_object: response.body)
  end
end

#update_container_image(id:, packages:, tag:, user_script: nil, is_hotswappable: nil, server_version: nil, request_options: nil) ⇒ Object

)



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/vellum_ai/container_images/client.rb', line 421

def update_container_image(id:, packages:, tag:, user_script: nil, is_hotswappable: nil, server_version: nil, request_options: nil)
  Async do
    response = @request_client.conn.put do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), packages: packages, tag: tag, user_script: user_script, is_hotswappable: is_hotswappable, server_version: server_version }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images/#{id}"
end
    Vellum::ContainerImageRead.from_json(json_object: response.body)
  end
end