occ_download_cancel {rgbif} | R Documentation |
Cancel a download creation process.
Description
Cancel a download creation process.
Usage
occ_download_cancel(key, user = NULL, pwd = NULL, curlopts = list())
occ_download_cancel_staged(
user = NULL,
pwd = NULL,
limit = 20,
start = 0,
curlopts = list()
)
Arguments
key |
(character) A key generated from a request, like that from
|
user |
(character) User name within GBIF's website. Required. See Details. |
pwd |
(character) User password within GBIF's website. Required. See Details. |
curlopts |
list of named curl options passed on to
|
limit |
Number of records to return. Default: 20 |
start |
Record number to start at. Default: 0 |
Details
Note, these functions only cancel a job in progress. If your download is already prepared for you, this won't do anything to change that.
occ_download_cancel
cancels a specific job by download key - returns
success message
occ_download_cancel_staged
cancels all jobs with status RUNNING
or PREPARING
- if none are found, returns a message saying so -
if some found, they are cancelled, returning message saying so
Note
see downloads for an overview of GBIF downloads methods
See Also
Other downloads:
download_predicate_dsl
,
occ_download_cached()
,
occ_download_dataset_activity()
,
occ_download_datasets()
,
occ_download_get()
,
occ_download_import()
,
occ_download_list()
,
occ_download_meta()
,
occ_download_queue()
,
occ_download_wait()
,
occ_download()
Examples
## Not run:
# occ_download_cancel(key="0003984-140910143529206")
# occ_download_cancel_staged()
## End(Not run)