terminate_jobs {connectapi} | R Documentation |
Terminate Jobs
Description
Register a job kill order for one or more jobs associated with a content item. Requires Connect 2022.10.0 or newer.
Usage
terminate_jobs(content, keys = NULL)
Arguments
content |
A Content object, as returned by |
keys |
Optional. One or more job keys, which can be obtained using
|
Value
A data frame with the status of each termination request.
-
app_id
: The content item's identifier. -
app_guid
: The content item's GUID. -
job_key
: The job key. -
job_id
: The job's identifier. -
result
: The result string returned by Connect. -
code
: An error code,NA
if the request was successful. -
error
: An error message,NA
if the result was successful.
Note that app_id
, app_guid
, job_id
, and result
are NA
if the
request returns an error.
See Also
Other job functions:
get_job()
,
get_jobs()
,
get_log()
Other content functions:
content_delete()
,
content_item()
,
content_title()
,
content_update()
,
create_random_name()
,
dashboard_url()
,
dashboard_url_chr()
,
delete_thumbnail()
,
delete_vanity_url()
,
deploy_repo()
,
get_bundles()
,
get_environment()
,
get_image()
,
get_job()
,
get_jobs()
,
get_log()
,
get_thumbnail()
,
get_vanity_url()
,
git
,
has_thumbnail()
,
permissions
,
set_image_path()
,
set_run_as()
,
set_thumbnail()
,
set_vanity_url()
,
swap_vanity_url()
,
swap_vanity_urls()
,
verify_content_name()
Examples
## Not run:
client <- connect()
item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
result <- terminate_jobs(item)
## End(Not run)