Class: PlatformAPI::OciImage

Inherits:

Object

• Object
• PlatformAPI::OciImage

Defined in:

lib/platform-api/client.rb

Overview

An OCI (Open Container Initiative) image is a standardized format for packaging and distributing containerized applications, ready to run on the platform.

Instance Method Summary

• #create(app_id_or_app_name, body = {}) ⇒ Object

  Create an new OCI image of an app.

• #info(app_id_or_app_name, oci_image_id_or_oci_image_digest) ⇒ Object

  Info for the OCI images of an app, filtered by identifier.

• #initialize(client) ⇒ OciImage constructor

  A new instance of OciImage.

Constructor Details

#initialize(client) ⇒ OciImage

Returns a new instance of OciImage.

# File 'lib/platform-api/client.rb', line 2345

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body = {}) ⇒ Object

Create an new OCI image of an app

Parameters:

• app_id_or_app_name: —

  unique identifier of app or unique name of app

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 2361

def create(app_id_or_app_name, body = {})
  @client.oci_image.create(app_id_or_app_name, body)
end

#info(app_id_or_app_name, oci_image_id_or_oci_image_digest) ⇒ Object

Info for the OCI images of an app, filtered by identifier.

Parameters:

• app_id_or_app_name: —

  unique identifier of app or unique name of app

• oci_image_id_or_oci_image_digest: —

  unique identifier of the OCI image or unique identifier representing the content of the OCI image

# File 'lib/platform-api/client.rb', line 2353

def info(app_id_or_app_name, oci_image_id_or_oci_image_digest)
  @client.oci_image.info(app_id_or_app_name, oci_image_id_or_oci_image_digest)
end