ray.job_submission.JobDetails#

pydantic model ray.job_submission.JobDetails[source]#

Job data with extra details about its driver and its submission.

PublicAPI (beta): This API is in beta and may change before becoming stable.

Fields:

  • driver_agent_http_address (str | None)

  • driver_exit_code (int | None)

  • driver_info (ray.dashboard.modules.job.pydantic_models.DriverInfo | None)

  • driver_node_id (str | None)

  • end_time (int | None)

  • entrypoint (str)

  • error_type (str | None)

  • job_id (str | None)

  • message (str | None)

  • metadata (Dict[str, str] | None)

  • runtime_env (Dict[str, Any] | None)

  • start_time (int | None)

  • status (ray.dashboard.modules.job.common.JobStatus)

  • submission_id (str | None)

  • type (ray.dashboard.modules.job.pydantic_models.JobType)

field driver_agent_http_address: str | None = None#

The HTTP address of the JobAgent on the node the job entrypoint command is running on.

field driver_exit_code: int | None = None#

The driver process exit code after the driver executed. Return None if driver doesn’t finish executing.

field driver_info: DriverInfo | None = None#

The driver related to this job. For jobs submitted via the Ray Jobs API, it is the last driver launched by that job submission, or None if there is no driver.

field driver_node_id: str | None = None#

The ID of the node the job entrypoint command is running on.

field end_time: int | None = None#

The time when the job moved into a terminal state. A Unix timestamp in ms.

field entrypoint: str [Required]#

The entrypoint command for this job.

field error_type: str | None = None#

Internal error or user script error.

field job_id: str | None = None#

The job ID. An ID that is created for every job that is launched in Ray. This can be used to fetch data about jobs using Ray Core APIs.

field message: str | None = None#

A message describing the status in more detail.

field metadata: Dict[str, str] | None = None#

Arbitrary user-provided metadata for the job.

field runtime_env: Dict[str, Any] | None = None#

The runtime environment for the job.

field start_time: int | None = None#

The time when the job was started. A Unix timestamp in ms.

field status: JobStatus [Required]#

The status of the job.

field submission_id: str | None = None#

A submission ID is an ID created for every job submitted viathe Ray Jobs API. It can be used to fetch data about jobs using the Ray Jobs API.

field type: JobType [Required]#

The type of job.