Skip to main content

Module clients.sandbox_engine_template.client

Classes​

SandboxEngineTemplateClient​

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

SandboxEngineTemplateClient manages SandboxEngineTemplates.

Initializes SandboxEngineTemplateClient.

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

def apply_sandbox_engine_template_configs(self, configs: List[h2o_engine_manager.clients.sandbox_engine_template.template_config.SandboxEngineTemplateConfig], parent: str = 'workspaces/global') ‑> List[h2o_engine_manager.clients.sandbox_engine_template.template.SandboxEngineTemplate]

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

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

Returns: applied SandboxEngineTemplates

create_sandbox_engine_template ​

def create_sandbox_engine_template(self, parent: str, sandbox_engine_template: h2o_engine_manager.clients.sandbox_engine_template.template.SandboxEngineTemplate, sandbox_engine_template_id: str) ‑> h2o_engine_manager.clients.sandbox_engine_template.template.SandboxEngineTemplate

Standard Create method.

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

delete_all_sandbox_engine_templates ​

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

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

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

delete_sandbox_engine_template ​

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

Standard Delete method.

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

get_sandbox_engine_template ​

def get_sandbox_engine_template(self, name: str) ‑> h2o_engine_manager.clients.sandbox_engine_template.template.SandboxEngineTemplate

Standard Get method.

Args​
name
Name of the SandboxEngineTemplate to retrieve. Format: workspaces/*/sandboxEngineTemplates/*

list_all_sandbox_engine_templates ​

def list_all_sandbox_engine_templates(self, parent: str) ‑> List[h2o_engine_manager.clients.sandbox_engine_template.template.SandboxEngineTemplate]

Help method for listing all SandboxEngineTemplates.

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

list_sandbox_engine_templates ​

def list_sandbox_engine_templates(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.sandbox_engine_template.page.SandboxEngineTemplatesPage

Standard list method.

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

update_sandbox_engine_template ​

def update_sandbox_engine_template(self, sandbox_engine_template: h2o_engine_manager.clients.sandbox_engine_template.template.SandboxEngineTemplate, update_mask: str = '*') ‑> h2o_engine_manager.clients.sandbox_engine_template.template.SandboxEngineTemplate

Standard Update method.

Args​
sandbox_engine_template : SandboxEngineTemplate
template to update.
update_mask : str
The field mask to use for the update. Allowed field paths are: - display_name - milli_cpu_request - milli_cpu_limit - gpu_resource - gpu - memory_bytes_request - memory_bytes_limit - storage_bytes - environmental_variables - yaml_pod_template_spec - enabled - max_idle_duration Default value "*" will update all updatable fields.
Returns​
SandboxEngineTemplate
Updated SandboxEngineTemplate.
Feedback