Poll a Gemini Batch job until completion
Source:R/gemini_batch_api.R
gemini_poll_batch_until_complete.RdThis helper repeatedly calls gemini_get_batch until the
batch's metadata$state enters a terminal state or a time limit is
reached. For the REST API, states have the form "BATCH_STATE_*".
Usage
gemini_poll_batch_until_complete(
batch_name,
interval_seconds = 60,
timeout_seconds = 86400,
api_key = Sys.getenv("GEMINI_API_KEY"),
api_version = "v1beta",
verbose = TRUE
)Arguments
- batch_name
Character scalar giving the batch name.
- interval_seconds
Polling interval in seconds. Defaults to 60.
- timeout_seconds
Maximum total waiting time in seconds. Defaults to 24 hours (86400 seconds).
- api_key
Optional Gemini API key. Defaults to
Sys.getenv("GEMINI_API_KEY").- api_version
API version string for the path; defaults to
"v1beta".- verbose
Logical; if
TRUE, prints progress messages.
Value
The final Batch job object as returned by
gemini_get_batch.
Examples
# Offline: polling parameters and batch name are plain R objects
batch_name <- "batches/123456"
# Online: poll until the batch reaches a terminal state (requires network)
if (FALSE) { # \dontrun{
final_batch <- gemini_poll_batch_until_complete(
batch_name = batch_name,
interval_seconds = 10,
timeout_seconds = 600,
verbose = TRUE
)
final_batch$metadata$state
} # }