ListJobs: Retrieve information about jobs

View source: R/Jobs.R

ListJobsR Documentation

Retrieve information about jobs

Description

This function requests information about the jobs that go through the DataRobot queue.

Usage

ListJobs(project, status = NULL)

Arguments

project

character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

status

character. The status of the desired jobs: one of JobStatus$Queue, JobStatus$InProgress, orJobStatus$Error. If NULL (default), queued and inprogress jobs are returned.

Value

A list of lists with one element for each job. The named list for each job contains:

  • status character. Model job status; an element of JobStatus, e.g. JobStatus$Queue.

  • url character. URL to request more detail about the job.

  • id character. The job id.

  • jobType character. See JobType for valid values.

  • projectId character. The project that contains the model.

  • isBlocked logical. If TRUE, the job is blocked (cannot be executed) until its dependencies are resolved.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  ListJobs(projectId)

## End(Not run)

datarobot documentation built on May 29, 2024, 4:36 a.m.