Skip to main content

Module clients.notebook_image.client

Classes​

NotebookImageClient​

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

NotebookImageClient manages NotebookImages.

Initializes NotebookImageClient.

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

def apply_notebook_image_configs(self, configs: List[h2o_engine_manager.clients.notebook_image.image_config.NotebookImageConfig], parent: str = 'workspaces/global') ‑> List[h2o_engine_manager.clients.notebook_image.image.NotebookImage]

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

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

Returns: applied NotebookImages

create_notebook_image ​

def create_notebook_image(self, parent: str, notebook_image: h2o_engine_manager.clients.notebook_image.image.NotebookImage, notebook_image_id: str) ‑> h2o_engine_manager.clients.notebook_image.image.NotebookImage

Standard Create method.

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

delete_all_notebook_images ​

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

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

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

delete_notebook_image ​

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

Standard Delete method.

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

get_notebook_image ​

def get_notebook_image(self, name: str) ‑> h2o_engine_manager.clients.notebook_image.image.NotebookImage

Standard Get method.

Args​
name
Name of the NotebookImage to retrieve. Format: workspaces/*/NotebookImages/*

list_all_notebook_images ​

def list_all_notebook_images(self, parent: str) ‑> List[h2o_engine_manager.clients.notebook_image.image.NotebookImage]

Help method for listing all NotebookImages.

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

list_notebook_images ​

def list_notebook_images(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.notebook_image.page.NotebookImagesPage

Standard list method.

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

update_notebook_image ​

def update_notebook_image(self, notebook_image: h2o_engine_manager.clients.notebook_image.image.NotebookImage, update_mask: str = '*') ‑> h2o_engine_manager.clients.notebook_image.image.NotebookImage

Standard Update method.

Args​
notebook_image : NotebookImage
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​
NotebookImage
Updated NotebookImage.
Feedback