ray.util.state.common.RuntimeEnvState#

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

Bases: ray.util.state.common.StateSchema

Runtime Environment State

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

error

success

runtime_env

node_id

Below columns are available only when get API is used,

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

node_id

error

runtime_env

ref_cnt

success

creation_time_ms

runtime_env: dict#

The runtime environment spec.

success: bool#

Whether or not the runtime env creation has succeeded.

creation_time_ms: Optional[float]#

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: Optional[int] = None#

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

error: Optional[str] = None#

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