c8y(1)

πŸ“¦ version 2.56.1, in nixpkgs unstable

πŸŽ€ c8y-datahub-jobs-listResults πŸŽ€

okay bestie πŸ’– welcome to the c8y manual page for c8y-datahub-jobs-listResults. yes, the name is a whole train of hyphens, but she's iconic and she has one job: pull query results for a Dremio job. let's get into it 🫢

✨ NAME ✨

c8y-datahub-jobs-listResults β€” retrieve the query results given the ID of the Dremio job that has executed the query. that's the whole assignment, no cap πŸ’…

🌸 SYNOPSIS 🌸

c8y datahub jobs listResults [flags]

πŸ’– DESCRIPTION πŸ’–

You bring the unique ID of a Dremio job that ran a query, and this command fetches the query results for you. That's it. It's giving "results please, and make it snappy" ✨

πŸ”₯ OPTIONS πŸ”₯

  • -h, --help[=false] β€” help for listResults. your little "what does this do again?" button 🫢
  • --id="" β€” the unique identifier of a Dremio job β€” required β€” and it accepts pipeline. yes, required required, don't skip her πŸ’…
  • --offset=0 β€” the offset of the paginated results.

🫢 OPTIONS INHERITED FROM PARENT COMMANDS 🫢

these came from the parent commands and are tagging along, so don't forget they exist πŸ’œ

  • --abortOnErrors=10 β€” abort the batch when reaching the specified number of errors.
  • --allowEmptyPipe[=false] β€” don't fail when piped input is empty (stdin).
  • --cache[=false] β€” enable cached responses.
  • --cacheBodyPaths=[] β€” cache should limit hashing of selected paths in the json body. empty indicates all values.
  • --cacheTTL="60s" β€” cache time-to-live (TTL) as a duration, i.e. 60s, 2m.
  • -c, --compact[=false] β€” compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal.
  • --confirm[=false] β€” prompt for confirmation.
  • --confirmText="" β€” custom confirmation text.
  • --currentPage=0 β€” current page which should be returned.
  • --customQueryParam=[] β€” add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
  • --debug[=false] β€” set very verbose log messages.
  • --delay="0ms" β€” delay after each request, i.e. 5ms, 1.2s.
  • --delayBefore="0ms" β€” delay before each request, i.e. 5ms, 1.2s.
  • --dry[=false] β€” dry run. don't send any data to the server.
  • --dryFormat="markdown" β€” dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] β€” show examples for the current command.
  • --filter=[] β€” apply a client side filter to response before returning it to the user.
  • --flatten[=false] β€” flatten json output by replacing nested json properties with properties where their names are represented by dot notation.
  • -f, --force[=false] β€” do not prompt for confirmation. ignored when using --confirm.
  • -H, --header=[] β€” custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] β€” include all results by iterating through each page.
  • -k, --insecure[=false] β€” allow insecure server connections when using SSL.
  • -l, --logMessage="" β€” add custom message to the activity log.
  • --maxJobs=0 β€” maximum number of jobs. 0 = unlimited (use with caution!) ⚠️
  • --noAccept[=false] β€” ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect.
  • --noCache[=false] β€” force disabling of cached responses (overwrites cache setting).
  • -M, --noColor[=false] β€” don't use colors when displaying log entries on the console.
  • --noLog[=false] β€” disables the activity log for the current command.
  • --noProgress[=false] β€” disable progress bars.
  • --noProxy[=false] β€” ignore the proxy settings.
  • -n, --nullInput[=false] β€” don't read the input (stdin). useful if using in shell for/while loops.
  • -o, --output="table" β€” output format i.e. table, json, csv, csvheader.
  • --outputFile="" β€” save json output to file (after select/view).
  • --outputFileRaw="" β€” save raw response to file (before select/view).
  • --outputTemplate="" β€” jsonnet template to apply to the output.
  • -p, --pageSize=5 β€” maximum results per page.
  • --progress[=false] β€” show progress bar. this will also disable any other verbose output.
  • --proxy="" β€” proxy setting, i.e. http://10.0.0.1:8080.
  • -r, --raw[=false] β€” show raw response. this mode will force output=json and view=off.
  • --retries=3 β€” max number of attempts when a failed http call is encountered.
  • --select=[] β€” comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
  • --session="" β€” session configuration.
  • --sessionMode="" β€” override default session mode for a single command which would normally be disabled.
  • -P, --sessionPassword="" β€” override session password.
  • -U, --sessionUsername="" β€” override session username. i.e. peter or t1234/peter (with tenant).
  • --silentExit[=false] β€” silent status codes do not affect the exit code.
  • --silentStatusCodes="" β€” status codes which will not print out an error message.
  • --timeout="600s" β€” request timeout duration, i.e. 60s, 2m.
  • --totalPages=0 β€” total number of pages to get.
  • -v, --verbose[=false] β€” verbose logging.
  • --view="auto" β€” use views when displaying data on the terminal. disable using --view off.
  • --withError[=false] β€” errors will be printed on stdout instead of stderr.
  • --withTotalElements[=false] β€” request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13).
  • -t, --withTotalPages[=false] β€” request Cumulocity to include the total pages in the response statistics under .statistics.totalPages.
  • --workers=1 β€” number of workers.

🌈 EXAMPLE 🌈

here are the examples, and yes the second one is doing the most with custom datahub pagination πŸ’…

$ c8y datahub jobs listResults --id "22feee74-875a-561c-5508-04114bdda000"
Retrieve results from a datahub job

$ c8y datahub jobs listResults --id "22feee74-875a-561c-5508-04114bdda000" --offset 2 --pageSize 100
Retrieve results from a datahub job with custom datahub pagination

πŸ¦‹ SEE ALSO πŸ¦‹

  • c8y-datahub-jobs(1) β€” the parent-command page, right there if you want the whole family vibe 🫢

that's the page, bestie πŸ’– β€” c8y(1), dated Jan 1980, signing off πŸŽ€

πŸ“¦ where this page comes from