Synopsis
fcli ssc artifact wait-for [-i=<intervalPeriod>] [--on-failure-state=<onFailureState>] [--on-timeout=<onTimeout>] [--on-unknown-state=<onUnknownState>] [--on-unknown-state-requested=<onUnknownStateRequeste _ d>_] [--progress=<type>] [-t=<timeoutPeriod>] [-s=<states>[,<states>…]]… [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[-o=<type+args>] [--style*=<style>,…]… ] [--to-file=<outputFile>_]] [-u=any-match|all-match | -w=any-match|all-match] [[--ssc-session=<sessionName>]] artifact-id’s…
Description
Although this command offers a lot of options to cover many different use cases, you can simply pass an artifact id (possibly stored using --store on the 'artifact upload' command) to wait for artifact processing completion. If any error state or unknown state is detected, an exception will be thrown.
The following states are currently known by fcli: SCHED_PROCESSING, PROCESSING, PROCESS_COMPLETE, ERROR_PROCESSING, AUTH_DENIED, REQUIRE_AUTH, DELETING, ERROR_DELETING, DELETED, PURGING, PURGED, ERROR_PURGING, DISPATCH_ANALYSIS, DISPATCH_REAUDIT, ERROR_DISPATCH, QUEUED_ANALYSIS, REQUEUED_ANALYSIS, ANALYZING, ANALYSIS_COMPLETE, ERROR_ANALYZING, UNKNOWN, AUDIT_FAILED
Options
- -i, --interval=<intervalPeriod>
-
Polling interval, for example 5s (5 seconds) or 1m (1 minute).
- --on-failure-state=<onFailureState>
-
Action to take when a failure state is returned for any of the records: wait, terminate, fail.
- --on-timeout=<onTimeout>
-
Action to take when timeout occurs: terminate, fail.
- --on-unknown-state=<onUnknownState>
-
Action to take when an unknown state is returned for any of the records: wait, terminate, fail.
- --on-unknown-state-requested=<onUnknownStateRequested>
-
Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.
- --progress=<type>
-
Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.
- -s, --any-state=<states>[,<states>…]
-
One or more processing states against which to match the given artifacts.
- -t, --timeout=<timeoutPeriod>
-
Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).
- -u, --until=any-match|all-match
-
Wait until either any or all artifacts match. If neither --until or --while are specified, default is to wait until all artifacts match.
- -w, --while=any-match|all-match
-
Wait while either any or all artifacts match.
SSC session name options
- --ssc-session=<sessionName>
-
Name of the SSC session to use for executing this command. Default value: default.
Output options (also see documentation link below)
- -o, --output=<type+args>
-
Select output type (csv, table, expr, json, xml, yaml) and optional type arguments.
- --store=<var>[:<prop>]
-
Store JSON results in an fcli variable for later reference.
- *--style*=<style>,…
-
Select output style: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.
- --to-file=<outputFile>
-
Write output to the specified file.
Generic fcli options (also see documentation link below)
- --debug
-
Enable collection of debug logs.
- --env-prefix=<prefix>
-
Prefix for resolving default option values. Default value: FCLI_DEFAULT.
- -h, --help
-
Use 'fcli [command] -h' to display help for fcli (sub-)commands.
- --log-file=<logFile>
-
Write log output to file. Default: ./fcli.log if logging is enabled.
- --log-level=<logLevel>
-
Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.
- --log-mask=<level>
-
Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.