GLOBUS TASK WAIT

NAME

globus task wait - Wait for a task to complete.

SYNOPSIS

globus task wait [OPTIONS] TASK_ID

DESCRIPTION

Wait for a task to complete.

This command waits until the timeout is reached, checking every 'M' seconds (where 'M' is the polling interval).

If the task succeeds by then, it exits with status 0. Otherwise, it exits with status 1.

OPTIONS

--timeout-exit-code INTEGER

If the task times out, exit with this status code. Must have a value in 0,1,50-99 [default: 1]

-H, --heartbeat

Every polling interval, print "." to stdout to indicate that task wait is still active

--polling-interval INTEGER

Number of seconds between task status checks. [default: 1]

--timeout N

Wait N seconds. If the task does not terminate by then, or terminates with an unsuccessful status, exit with status 1

-v, --verbose

Control level of output, make it more verbose.

--quiet

Suppress non-essential output. This is higher precedence than --verbose.

-h, --help

Show this message and exit.

-F, --format [unix|json|text]

Output format for stdout. Defaults to text.

--jmespath, --jq TEXT

A JMESPath expression to apply to json output. Forces the format to be json processed by this expression.

--map-http-status TEXT

Map HTTP statuses to any of these exit codes: 0,1,50-99. e.g. "404=50,403=51"

OUTPUT

When text output is requested, no output is written to standard out. All output is written to standard error.

When JSON output is requested, the standard error output remains, but the task status after waiting will be sent to stdout.

EXAMPLES

Wait 30 seconds for a task to complete, printing heartbeats to stderr and producing a JSON description of the task at the end:

$ globus task wait --timeout 30 -H --format json TASK_ID

Wait for a task without limit, silently, polling every 5 minutes:

$ globus task wait --polling-interval 300 TASK_ID

EXIT STATUS

0 on success.

1 if a network or server error occurred, unless --map-http-status has been used to change exit behavior on http error codes.

2 if the command was used improperly.

3 if the command was used on the wrong type of object, e.g. a collection command used on an endpoint.

4 if the command has authentication or authorization requirements which were not met, as in ConsentRequired errors or missing logins.