ray.util.state.common.JobState#

class ray.util.state.common.JobState(*, type: JobType, job_id: str | None = None, submission_id: str | None = None, driver_info: DriverInfo | None = None, status: JobStatus, entrypoint: str, message: str | None = None, error_type: str | None = None, start_time: int | None = None, end_time: int | None = None, metadata: Dict[str, str] | None = None, runtime_env: Dict[str, Any] | None = None, driver_agent_http_address: str | None = None, driver_node_id: str | None = None, driver_exit_code: int | None = None)[source]#

Bases: StateSchema, JobDetails

The state of the job that’s submitted by Ray’s Job APIs or driver jobs

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

job_id

type

submission_id

status

Below columns are available only when get API is used,

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

status

runtime_env

driver_agent_http_address

type

metadata

entrypoint

job_id

message

start_time

driver_exit_code

error_type

driver_node_id

driver_info

end_time

submission_id

classmethod filterable_columns() → Set[str][source]#

Return a list of filterable columns

classmethod humanify(state: dict) → dict[source]#

Convert the given state object into something human readable.

classmethod list_columns(detail: bool = True) → List[str][source]#

Return a list of columns.