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

Description Usage Arguments Value Examples

View source: R/DeletePredictJob.R

Description

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

Usage

1
DeletePredictJob(project, predictJobId)

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. Id identifying the prediction job created by the call to RequestPredictions.

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.

Examples

1
2
3
4
5
6
7
8
## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  initialJobs <- GetPredictJobs(project)
  job <- initialJobs[[1]]
  predictJobId <- job$predictJobId
  DeletePredictJob(projectId, predictJobId)

## End(Not run)

datarobot documentation built on Sept. 21, 2017, 1:05 a.m.