Class Runtime (1.10.1)

Runtime(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The definition of a Runtime for a managed notebook instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
name str
Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}
virtual_machine google.cloud.notebooks_v1.types.VirtualMachine
Use a Compute Engine VM image to start the managed notebook instance. This field is a member of oneof_ runtime_type.
state google.cloud.notebooks_v1.types.Runtime.State
Output only. Runtime state.
health_state google.cloud.notebooks_v1.types.Runtime.HealthState
Output only. Runtime health_state.
access_config google.cloud.notebooks_v1.types.RuntimeAccessConfig
The config settings for accessing runtime.
software_config google.cloud.notebooks_v1.types.RuntimeSoftwareConfig
The config settings for software inside the runtime.
metrics google.cloud.notebooks_v1.types.RuntimeMetrics
Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Runtime creation time.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Runtime update time.

Classes

HealthState

HealthState(value)

The runtime substate.

Values: HEALTH_STATE_UNSPECIFIED (0): The runtime substate is unknown. HEALTHY (1): The runtime is known to be in an healthy state (for example, critical daemons are running) Applies to ACTIVE state. UNHEALTHY (2): The runtime is known to be in an unhealthy state (for example, critical daemons are not running) Applies to ACTIVE state. AGENT_NOT_INSTALLED (3): The runtime has not installed health monitoring agent. Applies to ACTIVE state. AGENT_NOT_RUNNING (4): The runtime health monitoring agent is not running. Applies to ACTIVE state.

State

State(value)

The definition of the states of this runtime.

Values: STATE_UNSPECIFIED (0): State is not specified. STARTING (1): The compute layer is starting the runtime. It is not ready for use. PROVISIONING (2): The compute layer is installing required frameworks and registering the runtime with notebook proxy. It cannot be used. ACTIVE (3): The runtime is currently running. It is ready for use. STOPPING (4): The control logic is stopping the runtime. It cannot be used. STOPPED (5): The runtime is stopped. It cannot be used. DELETING (6): The runtime is being deleted. It cannot be used. UPGRADING (7): The runtime is upgrading. It cannot be used. INITIALIZING (8): The runtime is being created and set up. It is not ready for use.