GetPredictJobs: Function to list all prediction jobs in a project

View source: R/GetPredictJobs.R

GetPredictJobsR Documentation

Function to list all prediction jobs in a project

Description

Function to list all prediction jobs in a project

Usage

GetPredictJobs(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

Dataframe with one row for each prediction job in the queue, with the following columns:

status

Prediction job status; one of JobStatus$Queue, JobStatus$InProgress, or JobStatus$Error

predictJobId

Character string specifying the job id

modelId

Character string specifying the model from which predictions have been requested

projectId

Character string specifying the project that contains the model

Examples

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

## End(Not run)

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