ray.util.state.common.RuntimeEnvState

class ray.util.state.common.RuntimeEnvState(runtime_env: dict, success: bool, creation_time_ms: float | None, node_id: str, ref_cnt: int | None = None, error: str | None = None)

Bases: StateSchema

Runtime Environment State

Below columns can be used for the --filter option.

node_id

error

success

runtime_env

Below columns are available only when get API is used,

--detail is specified through CLI, or detail=True is given to Python APIs.

error

runtime_env

creation_time_ms

success

ref_cnt

node_id

runtime_env: dict

The runtime environment spec.

success: bool

Whether or not the runtime env creation has succeeded.

creation_time_ms: float | None

The latency of creating the runtime environment. Available if the runtime env is successfully created.

node_id: str

The node id of this runtime environment.

ref_cnt: int | None = None

The number of actors and tasks that use this runtime environment.

error: str | None = None

The error message if the runtime environment creation has failed. Available if the runtime env is failed to be created.