Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IListTasksOptions

Hierarchy

Index

Properties

Optional dotView

dotView: "labels" | "attributes"

One of labels or attributes. Labels is less readable but will correctly render with all the information contained in labels.

default

attributes

Optional fields

fields: TaskFields[]

List of fields to return. If empty returns all fields. Fields id and link are always returned.

Optional limit

limit: number

Maximum number of tasks to return.

default

100

Optional offset

offset: number

Offset count for paginating through tasks.

default

0

Optional pattern

pattern: string

Filter results based on the pattern. Uses standard shell glob matching, see this for more details.

Optional replayId

replayId: string

Optional ID of a running replay.The returned task information will be in the context of the task for the running replay.

Optional scriptFormat

scriptFormat: "formatted" | "raw"

One of formatted or raw. Raw will return the script identical to how it was defined. Formatted will first format the script.

default

formatted

Generated using TypeDoc