Skip to main content

Module clients.sandbox_engine_image.client

Classes​

SandboxEngineImageClient​

class SandboxEngineImageClient(connection_config: h2o_engine_manager.clients.connection_config.ConnectionConfig, verify_ssl: bool = True, ssl_ca_cert: Optional[str] = None)

SandboxEngineImageClient manages SandboxEngineImages.

Initializes SandboxEngineImageClient.

Args​
connection_config : ConnectionConfig
AIEM connection configuration object.
verify_ssl
Set to False to disable SSL certificate verification.
ssl_ca_cert
Path to a CA cert bundle with certificates of trusted CAs.

Methods​

apply_sandbox_engine_image_configs ​

def apply_sandbox_engine_image_configs(self, configs: List[h2o_engine_manager.clients.sandbox_engine_image.image_config.SandboxEngineImageConfig], parent: str = 'workspaces/global') ‑> List[h2o_engine_manager.clients.sandbox_engine_image.image.SandboxEngineImage]

Set all SandboxEngineImages to a state defined in the configs in the specified parent workspace. SandboxEngineImages that are not specified in the configs will be deleted in the specified parent workspace. SandboxEngineImages that are specified in the configs will be recreated with the new values in the specified parent workspace.

Args​
configs
SandboxEngineImage configurations that should be applied.
parent
Workspace name in which to apply configs. Format is workspaces/*.

Returns: applied SandboxEngineImages

create_sandbox_engine_image ​

def create_sandbox_engine_image(self, parent: str, sandbox_engine_image: h2o_engine_manager.clients.sandbox_engine_image.image.SandboxEngineImage, sandbox_engine_image_id: str) ‑> h2o_engine_manager.clients.sandbox_engine_image.image.SandboxEngineImage

Standard Create method.

Args​
parent : str
Name of the version's parent workspace. Format: workspaces/*.
sandbox_engine_image : SandboxEngineImage
SandboxEngineImage to create.
sandbox_engine_image_id : str
Specify the SandboxEngineImage ID, which will become a part of the SandboxEngineImage resource name. It must: - contain 1-63 characters - contain only lowercase alphanumeric characters or hyphen ('-') - start with an alphabetic character - end with an alphanumeric character
Returns​
SandboxEngineImage
created SandboxEngineImage.

delete_all_sandbox_engine_images ​

def delete_all_sandbox_engine_images(self, parent: str) ‑> None

Help method for deleting all SandboxEngineImages in a specified parent workspace.

Args​
parent : str
Parent workspace name. Format is workspaces/*.

delete_sandbox_engine_image ​

def delete_sandbox_engine_image(self, name: str) ‑> None

Standard Delete method.

Args​
name : str
Name of the SandboxEngineImage to delete. Format is workspaces/global/sandboxEngineImages/*

get_sandbox_engine_image ​

def get_sandbox_engine_image(self, name: str) ‑> h2o_engine_manager.clients.sandbox_engine_image.image.SandboxEngineImage

Standard Get method.

Args​
name
Name of the SandboxEngineImage to retrieve. Format: workspaces/global/sandboxEngineImages/*

list_all_sandbox_engine_images ​

def list_all_sandbox_engine_images(self, parent: str) ‑> List[h2o_engine_manager.clients.sandbox_engine_image.image.SandboxEngineImage]

Help method for listing all SandboxEngineImages.

Args​
parent : str
Name of the workspace from which to list versions. Format: workspaces/*.

list_sandbox_engine_images ​

def list_sandbox_engine_images(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.sandbox_engine_image.page.SandboxEngineImagesPage

Standard list method.

Args​
parent : str
Name of the workspace from which to list versions. Format: workspaces/*.
page_size : int
Maximum number of SandboxEngineImages to return in a response. If unspecified (or set to 0), at most 50 SandboxEngineImages will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token : str
Page token. Leave unset to receive the initial page. To list any subsequent pages use the value of 'next_page_token' returned from the SandboxEngineImagesPage.
Returns​
SandboxEngineImagesPage
SandboxEngineImagesPage object.

update_sandbox_engine_image ​

def update_sandbox_engine_image(self, sandbox_engine_image: h2o_engine_manager.clients.sandbox_engine_image.image.SandboxEngineImage, update_mask: str = '*') ‑> h2o_engine_manager.clients.sandbox_engine_image.image.SandboxEngineImage

Standard Update method.

Args​
sandbox_engine_image : SandboxEngineImage
version to update.
update_mask : str
The field mask to use for the update. Allowed field paths are: - display_name - enabled - image - image_pull_policy - image_pull_secrets Default value "*" will update all updatable fields.
Returns​
SandboxEngineImage
Updated SandboxEngineImage.
Feedback