Skip to main content

Module clients.notebook_engine.engine

Functions​

notebook_engine_from_api_object ​

def notebook_engine_from_api_object(api_object: h2o_engine_manager.gen.model.v1_notebook_engine.V1NotebookEngine) ‑> NotebookEngine

notebook_engine_to_api_object ​

def notebook_engine_to_api_object(notebook_engine: NotebookEngine) ‑> h2o_engine_manager.gen.model.v1_notebook_engine.V1NotebookEngine

notebook_engine_to_resource ​

def notebook_engine_to_resource(notebook_engine: NotebookEngine) ‑> h2o_engine_manager.gen.model.notebook_engine_resource.NotebookEngineResource

Classes​

NotebookEngine​

class NotebookEngine(profile: str, notebook_image: str, name: str = '', display_name: str = '', cpu: Optional[int] = None, gpu: Optional[int] = None, memory_bytes: Optional[str] = None, storage_bytes: Optional[str] = None, max_idle_duration: Optional[str] = None, max_running_duration: Optional[str] = None, state: h2o_engine_manager.clients.notebook_engine.state.NotebookEngineState = NotebookEngineState.STATE_UNSPECIFIED, reconciling: bool = False, uid: str = '', notebook_image_info: Optional[h2o_engine_manager.clients.notebook_engine.notebook_engine_image_info.NotebookEngineImageInfo] = None, profile_info: Optional[h2o_engine_manager.clients.notebook_engine.notebook_engine_profile_info.NotebookEngineProfileInfo] = None, creator: str = '', updater: str = '', creator_display_name: str = '', updater_display_name: str = '', create_time: Optional[datetime.datetime] = None, update_time: Optional[datetime.datetime] = None, resume_time: Optional[datetime.datetime] = None, delete_time: Optional[datetime.datetime] = None, current_idle_duration: Optional[str] = None, current_running_duration: Optional[str] = None, storage_class_name: str = '', failure_reason: h2o_engine_manager.clients.notebook_engine.failure_reson.NotebookEngineFailureReason = NotebookEngineFailureReason.FAILURE_REASON_UNSPECIFIED)

Engine that allows to run an interactive computing environment called notebook.

Args​
profile
The resource name of the NotebookEngineProfile that is assigned to this NotebookEngine. Format is workspaces/*/notebookEngineProfiles/*.
notebook_image
The resource name of the NotebookEngineImage used to create the NotebookEngine. Format is workspaces/*/notebookEngineImages/*.
name
The resource name of the NotebookEngine. Format: workspaces/*/notebookEngines/*.
display_name
Human-readable name.
cpu
The amount of CPU units requested by this NotebookEngine.
gpu
The amount of GPU units requested by this NotebookEngine.
memory_bytes
The amount of memory in bytes requested by this NotebookEngine. For example "1024", "8G", "16Gi".
storage_bytes
The amount of storage requested by this NotebookEngine. For example "1024", "8G", "16Gi".
max_idle_duration
Maximum time the NotebookEngine can be idle. When exceeded, the NotebookEngine will pause.
max_running_duration
Maximum time the NotebookEngine can be running. When exceeded, the NotebookEngine will pause.
state
The current state of the NotebookEngine.
reconciling
Indicates whether changes to the resource are in progress.
uid
Globally unique identifier of the resource.
notebook_image_info
NotebookEngineImage data used during the last NotebookEngine startup from the assigned notebook_image.
profile_info
NotebookEngineProfile data used during the last NotebookEngine startup from the assigned profile.
creator
Name of entity that created the NotebookEngine.
updater
Name of entity that last updated the NotebookEngine.
creator_display_name
Human-readable name of entity that created the NotebookEngine.
updater_display_name
Human-readable name of entity that last updated the NotebookEngine.
create_time
Time when the NotebookEngine was created.
update_time
Time when the NotebookEngine was last updated.
resume_time
Time when the NotebookEngine was resumed.
delete_time
Time when the NotebookEngine was deleted.
current_idle_duration
Current time the NotebookEngine is idle.
current_running_duration
Current time the NotebookEngine is running.
storage_class_name
Name of the storage class used by NotebookEngine.
pending_reason
Reason why the NotebookEngine cant be scheduled. If available.
failure_reason
Reason why the NotebookEngine is in failed state. If available.
Feedback