Skip to main content

Module clients.ide_engine_image.client

Classes​

IDEEngineImageClient​

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

IDEEngineImageClient manages IDEEngineImages.

Initializes IDEEngineImageClient.

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​

create_ide_engine_image ​

def create_ide_engine_image(self, parent: str, ide_engine_image: h2o_engine_manager.clients.ide_engine_image.image.IDEEngineImage, ide_engine_image_id: str) ‑> h2o_engine_manager.clients.ide_engine_image.image.IDEEngineImage

Standard Create method.

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

delete_ide_engine_image ​

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

Standard Delete method.

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

get_ide_engine_image ​

def get_ide_engine_image(self, name: str) ‑> h2o_engine_manager.clients.ide_engine_image.image.IDEEngineImage

Standard Get method.

Args​
name
Name of the IDEEngineImage to retrieve. Format: workspaces/*/ideEngineImages/*

list_all_ide_engine_images ​

def list_all_ide_engine_images(self, parent: str) ‑> List[h2o_engine_manager.clients.ide_engine_image.image.IDEEngineImage]

Help method for listing all IDEEngineImages.

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

list_ide_engine_images ​

def list_ide_engine_images(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.ide_engine_image.page.IDEEngineImagesPage

Standard list method.

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

update_ide_engine_image ​

def update_ide_engine_image(self, ide_engine_image: h2o_engine_manager.clients.ide_engine_image.image.IDEEngineImage, update_mask: str = '*') ‑> h2o_engine_manager.clients.ide_engine_image.image.IDEEngineImage

Standard Update method.

Args​
ide_engine_image : IDEEngineImage
IDEEngineImage 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​
IDEEngineImage
Updated IDEEngineImage.
Feedback