datarobot (version 2.18.6)

DeletePredictJob: Function to delete one predict job from the DataRobot queue

Description

This function deletes the predict job specified by predictJobId from the DataRobot queue.

Usage

DeletePredictJob(project, predictJobId)

Value

Logical TRUE and displays a message to the user if the delete request was successful; otherwise, execution halts and an error message is displayed.

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.

predictJobId

integer. The integer ID predictionJobId that is created by the call to RequestPredictions.

Examples

if (FALSE) {
  projectId <- "59a5af20c80891534e3c2bde"
  initialJobs <- GetPredictJobs(project)
  job <- initialJobs[[1]]
  predictJobId <- job$predictJobId
  DeletePredictJob(projectId, predictJobId)
}