Skip to main content

Module clients.h2o_engine.h2o_engine

Functions​

build_api_engine_name ​

def build_api_engine_name(workspace_id: str, engine_id: str) ‑> str

Function builds full OpenAPI resource name of an engine.

Args​
workspace_id : str
ID of the workspace.
engine_id : str
The ID of an engine.
Returns​
str
Full resource name of an engine.

from_h2o_engine_api_object ​

def from_h2o_engine_api_object(client_info: h2o_engine_manager.clients.h2o_engine.client_info.ClientInfo, api_engine: h2o_engine_manager.gen.model.v1_h2_o_engine.V1H2OEngine) ‑> H2OEngine

Classes​

H2OClusterConnectionConfig​

class H2OClusterConnectionConfig(*args, **kwargs)

Represents H2O cluster connection configuration object.

Class variables​

var cacert : str
var context_path : str
var https : bool
var ip : str
var port : int
var verify_ssl_certificates : bool

Ancestors​

  • builtins.dict
  • typing.Generic

H2OEngine​

class H2OEngine(node_count: int, cpu: int, gpu: int, memory_bytes: str, annotations: Dict[str, str], max_idle_duration: str, max_running_duration: str, display_name: str, name: str = '', state: h2o_engine_manager.clients.h2o_engine.state.H2OEngineState = H2OEngineState.STATE_UNSPECIFIED, creator: str = '', creator_display_name: str = '', create_time: datetime.datetime = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), update_time: Optional[datetime.datetime] = None, delete_time: Optional[datetime.datetime] = None, login_url: str = '', api_url: str = '', reconciling: bool = False, uid: str = '', client_info: Optional[h2o_engine_manager.clients.h2o_engine.client_info.ClientInfo] = None, current_running_duration: Optional[str] = None, current_idle_duration: Optional[str] = None, profile: str = '', profile_info: Optional[h2o_engine_manager.clients.h2o_engine.profile_info.H2OEngineProfileInfo] = None, h2o_engine_version: str = '', h2o_engine_version_info: Optional[h2o_engine_manager.clients.h2o_engine.h2o_engine_version_info.H2OEngineVersionInfo] = None)

Methods​

delete ​

def delete(self, allow_missing: bool = False, validate_only: bool = False)

Initiates deletion of the engine from its workspace. Once the engine is deleted, any further action with the engine will result in an error.

Args​
allow_missing : bool, optional
When set to True and the H2OEngine

is not found, then the request will succeed but no changes are made. validate_only(bool, optional): When set to True, request is validated but no changes are made.

download_logs ​

def download_logs(self) ‑> str

Download H2O logs.

Returns​

H2O logs

get_connection_config ​

def get_connection_config(self, https: bool = True, verify_ssl_certificates: bool = True, cacert: Optional[str] = '', port: int = 443) ‑> H2OClusterConnectionConfig

Returns configuration used for h2o.connect.

Args​
https : bool
True to use https. False to use http.
verify_ssl_certificates : bool
True to enable SSL certificate verification. False to disable.
cacert : str, optional
Path to a CA cert bundle with certificates of trusted CAs. Defaults to CA bundle from the AIEM client login function
port : int
Which port to connect to.

terminate ​

def terminate(self)

Terminates the engine and updates its data from the server response.

to_api_object ​

def to_api_object(self) ‑> h2o_engine_manager.gen.model.v1_h2_o_engine.V1H2OEngine

wait ​

def wait(self, timeout_seconds: Optional[float] = None)

Waits for the engine to reach a final (stable) state.

Args​
timeout_seconds : float, optional
Time limit in seconds for how

long to wait. If no timeout is specified, function will be blocking until the waiting is finished. Potentially forever in case of an unexpected error. Defaults to None.

wait_async ​

async def wait_async(self, timeout_seconds: Optional[float] = None)

Waits for an engine to reach a final (stable) state.

Args​
timeout_seconds : float, optional
Time limit in seconds for how

long to wait. If no timeout is specified, function will be blocking until the waiting is finished. Potentially forever in case of an unexpected error. Defaults to None.

Feedback