Skip to main content

Module clients.sandbox_engine.client

Classes​

SandboxEngineClient​

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

SandboxEngineClient manages SandboxEngines.

Args​
connection_config
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_sandbox_engine ​

def create_sandbox_engine(self, parent: str, sandbox_engine: h2o_engine_manager.clients.sandbox_engine.engine.SandboxEngine, sandbox_engine_id: str) ‑> h2o_engine_manager.clients.sandbox_engine.engine.SandboxEngine

Create sandbox engine.

Args​
parent : str
Name of the engine's parent workspace. Format: "workspaces/*".
sandbox_engine : SandboxEngine
SandboxEngine to create.
sandbox_engine_id : str
The ID to use for the SandboxEngine, which will form the engine'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​
SandboxEngine
created SandboxEngine.

delete_sandbox_engine ​

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

Start sandbox engine deletion. Method returns instantly, but it may take some time until the engine is deleted.

Args​
name
SandboxEngine resource name. Format: "workspaces//sandboxEngines/"

get_sandbox_engine ​

def get_sandbox_engine(self, name: str) ‑> h2o_engine_manager.clients.sandbox_engine.engine.SandboxEngine

Get sandbox engine.

Args​
name
SandboxEngine resource name. Format: "workspaces//sandboxEngines/"
Returns​
SandboxEngine
sandbox engine

list_all_sandbox_engines ​

def list_all_sandbox_engines(self, parent: str) ‑> List[h2o_engine_manager.clients.sandbox_engine.engine.SandboxEngine]

Help method for listing all SandboxEngines.

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

list_sandbox_engines ​

def list_sandbox_engines(self, parent: str, page_size: int = 0, page_token: str = '') ‑> h2o_engine_manager.clients.sandbox_engine.page.SandboxEnginesPage

Standard list method.

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

terminate_sandbox_engine ​

def terminate_sandbox_engine(self, name: str) ‑> h2o_engine_manager.clients.sandbox_engine.engine.SandboxEngine

Terminate sandbox engine. Method returns instantly, but it may take some time until the engine is terminated.

Args​
name
SandboxEngine resource name. Format: "workspaces//sandboxEngines/"

Returns: terminated sandboxEngine

wait ​

def wait(self, name: str, timeout_seconds: Optional[float] = None) ‑> Optional[h2o_engine_manager.clients.sandbox_engine.engine.SandboxEngine]

Blocks execution until the sandboxEngine with the given name reaches a stable state or until it is no longer found.

Args​
name
SandboxEngine resource name for which to wait. Format: "workspaces//sandboxEngines/"
timeout_seconds
Time limit in seconds for how long to wait.

Returns: engine that has finished waiting or nothing, if engine is no longer found.

Feedback