fredcli batch list

Display data about the most recent 20 batches run on the FRED platform.

Synopsis

fredcli batch list

Display data about the most recent 20 batches run on the FRED platform.

Returned data includes the batch’s ID (guid), status, created time, and the email address of the submitting user.

fredcli batch list [options]

Options

--output <output>

Choose output format, either human readable text, or json or yaml.

Default

text

Options

text | json | yaml

--start <start>

The starting row to display from the list of all available batches.

Default

1

--count <count>

The number of rows to display.

Default

20

--user <user>

Only list batches for the given user. As a flag, this shows only your batches.If a user email is given, then only batches created by this user are shown

Description

Returned data includes the batch’s ID (guid), status, created time, and the email address of the submitting user. The --output option specifies the format for this command: one of text, json, or yaml. The --user option filters the batches queried by the argument given to --user. If no argument is given to --user it operates as a flag, and defaults to querying batches by the username associated with the request. The --start option when used in conjunction with the --count option will return only the dataset in the range of start to count. The --start and --count options default to 1 and 20 respectively. When this command is called with no arguments passed to --start or --count, the 20 most recent batches will be displayed.

Examples

The following command retrieves metadata about the most recently submitted batches in a tabular format. This is the text output format, and is the default.

$ fredcli batch list
|                            Batch |    Status |                 Created |           Created By |   # Tasks |
|----------------------------------|-----------|-------------------------|----------------------|-----------|
| b911d40bb95a44f99d1dccf072f8cdb7 | Succeeded | 28/07/2021, 06:26:07 PM | [email protected] |         1 |
| ce4d9c03badf48fda2218f1c5363ef1a | Succeeded | 23/07/2021, 05:09:43 PM | [email protected] |         1 |
| c5544406ddef4453903f32eea3f04cd6 | Succeeded | 23/07/2021, 04:50:46 PM | [email protected] |         1 |
...

As another example, the same batch list status is shown with yaml output

$ fredcli batch list --output yaml
- batchGuid: b911d40bb95a44f99d1dccf072f8cdb7
  created: '2021-07-28T18:26:07.480Z'
  createdBy: [email protected]
  status: Succeeded
  tasks: 1
- batchGuid: ce4d9c03badf48fda2218f1c5363ef1a
  created: '2021-07-23T17:09:43.608Z'
  createdBy: [email protected]
  status: Succeeded
  tasks: 1
- batchGuid: c5544406ddef4453903f32eea3f04cd6
  created: '2021-07-23T16:50:46.378Z'
  createdBy: [email protected]
  status: Succeeded
  tasks: 1

In this example, the same batch list status is shown filtered by user user.1@epistemix.com with the default text output

$ fredcli batch list --user [email protected]
|                            Batch |    Status |                 Created |           Created By |   # Tasks |
|----------------------------------|-----------|-------------------------|----------------------|-----------|
| b911d40bb95a44f99d1dccf072f8cdb7 | Succeeded | 28/07/2021, 06:26:07 PM | [email protected] |         1 |
| c5544406ddef4453903f32eea3f04cd6 | Succeeded | 23/07/2021, 04:50:46 PM | [email protected] |         1 |

Here, the same batch list status is shown with --user as a flag, with the default text output. This example assumes that the user initiating the request is user.2@epistemix.com.

$ fredcli batch list --user
|                            Batch |    Status |                 Created |           Created By |   # Tasks |
|----------------------------------|-----------|-------------------------|----------------------|-----------|
| ce4d9c03badf48fda2218f1c5363ef1a | Succeeded | 23/07/2021, 05:09:43 PM | [email protected] |         1 |

Here, the batch list is shown with --start and --count options set to 1 and 2 respectively, without filtering by a user.

$ fredcli batch list --start 1 --count 2
|                            Batch |    Status |                 Created |           Created By |   # Tasks |
|----------------------------------|-----------|-------------------------|----------------------|-----------|
| b911d40bb95a44f99d1dccf072f8cdb7 | Succeeded | 28/07/2021, 06:26:07 PM | [email protected] |         1 |
| ce4d9c03badf48fda2218f1c5363ef1a | Succeeded | 23/07/2021, 05:09:43 PM | [email protected] |         1 |