Skip to main content

Module clients.kernel_image.client

Classes​

KernelImageClient​

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

KernelImageClient manages Python kernel images.

Methods​

apply_kernel_images ​

def apply_kernel_images(self, kernel_image_configs: List[h2o_notebook.clients.kernel_image.kernel_image_config.KernelImageConfig]) ‑> List[h2o_notebook.clients.kernel_image.kernel_image.KernelImage]

Set all KernelImages in global workspace to a state defined in kernel_image_configs. KernelImages not specified in the kernel_image_configs will be deleted. KernelImages specified in the kernel_image_configs will be recreated with the new values.

Args​
kernel_image_configs
configuration of KernelImages that should be applied.

Returns: applied KernelImages

create_kernel_image ​

def create_kernel_image(self, parent: str, kernel_image: h2o_notebook.clients.kernel_image.kernel_image.KernelImage, kernel_image_id: str) ‑> h2o_notebook.clients.kernel_image.kernel_image.KernelImage

Creates a KernelImage.

Args​
parent : str
The resource name of the workspace to associate with the KernelImage. Format is workspaces/*.
kernel_image : KernelImage
KernelImage to create.
kernel_image_id : str
The ID to use for the KernelImage, which will become the final component of the image's resource name. This value must: - contain 1-63 characters - contain only lowercase alphanumeric characters or hyphen ('-') - start with an alphabetic character - end with an alphanumeric character
Returns​
KernelImage
KernelImage object.

delete_all_kernel_images ​

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

Helper function for deleting all KernelImages.

Args​
parent : str
The resource name of the workspace to associate with the KernelImages that are to be deleted. Format is workspaces/*.

delete_kernel_image ​

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

Deletes a KernelImage.

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

get_kernel_image ​

def get_kernel_image(self, name: str) ‑> h2o_notebook.clients.kernel_image.kernel_image.KernelImage

Returns a KernelImage.

Args​
name : str
Name of the KernelImage to retrieve. Format is workspaces/*/kernelImages/*
Returns​
KernelImage
KernelImage object.

list_all_kernel_images ​

def list_all_kernel_images(self, parent: str) ‑> List[h2o_notebook.clients.kernel_image.kernel_image.KernelImage]

List all KernelImages.

Args​
parent : str
The resource name of the workspace to associate with the KernelImage. Format is workspaces/*.
Returns​

List of KernelImage.

list_kernel_images ​

def list_kernel_images(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_notebook.clients.kernel_image.page.KernelImagesPage

Lists KernelImages.

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

update_kernel_image ​

def update_kernel_image(self, kernel_image: h2o_notebook.clients.kernel_image.kernel_image.KernelImage, update_mask: str = '*') ‑> h2o_notebook.clients.kernel_image.kernel_image.KernelImage

Updates a KernelImage.

Args​
kernel_image : KernelImage
KernelImage object.
update_mask : str

The field mask to use for the update. Allowed field paths are: image_pull_secrets.

If not set, all fields will be updated. Defaults to "*".

Returns​
KernelImage
Updated KernelImage object.
Feedback