Skip to main content

Module clients.notebook_engine_image.client

Classes​

NotebookEngineImageClient​

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

NotebookEngineImageClient manages NotebookEngineImages.

Initializes NotebookEngineImageClient.

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_notebook_engine_image_configs ​

def apply_notebook_engine_image_configs(self, configs: List[h2o_engine_manager.clients.notebook_engine_image.image_config.NotebookEngineImageConfig], parent: str = 'workspaces/global') ‑> List[h2o_engine_manager.clients.notebook_engine_image.image.NotebookEngineImage]

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

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

Returns: applied NotebookEngineImages

create_notebook_engine_image ​

def create_notebook_engine_image(self, parent: str, notebook_engine_image: h2o_engine_manager.clients.notebook_engine_image.image.NotebookEngineImage, notebook_engine_image_id: str) ‑> h2o_engine_manager.clients.notebook_engine_image.image.NotebookEngineImage

Standard Create method.

Args​
parent : str
Name of the version's parent workspace. Format: workspaces/*.
notebook_engine_image : NotebookEngineImage
NotebookEngineImage to create.
notebook_engine_image_id : str
Specify the NotebookEngineImage ID, which will become a part of the NotebookEngineImage 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​
NotebookEngineImage
created NotebookEngineImage.

delete_all_notebook_engine_images ​

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

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

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

delete_notebook_engine_image ​

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

Standard Delete method.

Args​
name : str
Name of the NotebookEngineImage to delete. Format is workspaces/*/NotebookEngineImages/*

get_notebook_engine_image ​

def get_notebook_engine_image(self, name: str) ‑> h2o_engine_manager.clients.notebook_engine_image.image.NotebookEngineImage

Standard Get method.

Args​
name
Name of the NotebookEngineImage to retrieve. Format: workspaces/*/NotebookEngineImages/*

list_all_notebook_engine_images ​

def list_all_notebook_engine_images(self, parent: str) ‑> List[h2o_engine_manager.clients.notebook_engine_image.image.NotebookEngineImage]

Help method for listing all NotebookEngineImages.

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

list_notebook_engine_images ​

def list_notebook_engine_images(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.notebook_engine_image.page.NotebookEngineImagesPage

Standard list method.

Args​
parent : str
Name of the workspace from which to list versions. Format: workspaces/*.
page_size : int
Maximum number of NotebookEngineImages to return in a response. If unspecified (or set to 0), at most 50 NotebookEngineImages 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 NotebookEngineImagesPage.
Returns​
NotebookEngineImagesPage
NotebookEngineImagesPage object.

update_notebook_engine_image ​

def update_notebook_engine_image(self, notebook_engine_image: h2o_engine_manager.clients.notebook_engine_image.image.NotebookEngineImage, update_mask: str = '*') ‑> h2o_engine_manager.clients.notebook_engine_image.image.NotebookEngineImage

Standard Update method.

Args​
notebook_engine_image : NotebookEngineImage
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​
NotebookEngineImage
Updated NotebookEngineImage.
Feedback