cancelJob: Cancel an active LANDFIRE Product Service (LFPS) API job

View source: R/checkStatus.R

cancelJobR Documentation

Cancel an active LANDFIRE Product Service (LFPS) API job

Description

cancelJob() sends a request to cancel a LFPS API request

Usage

cancelJob(job_id)

Arguments

job_id

The job ID of the LFPS API request as a character string

Value

NULL. Prints a message to the console about the job status.

Examples

## Not run: 
products <-  c("LF2016_EVT", "LF2016_CC")
aoi <- c("-123.7835", "41.7534", "-123.6352", "41.8042")
email <- "email@example.com>"

resp <- landfireAPIv2(products, aoi, email, background = TRUE)

job_id <- resp$request$job_id #Get job_id from a previous request
cancelJob("job_id")

## End(Not run)

rlandfire documentation built on March 19, 2026, 1:06 a.m.