Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ToolTimeLimit

Auto-generated class implementation for https://w3id.org/cwl/cwl#ToolTimeLimit

Set an upper limit on the execution time of a CommandLineTool. A CommandLineTool whose execution duration exceeds the time limit may be preemptively terminated and considered failed. May also be used by batch systems to make scheduling decisions. The execution duration excludes external operations, such as staging of files, pulling a docker image etc, and only counts wall-time for the execution of the command line itself.

Hierarchy

  • Saveable
    • ToolTimeLimit

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

class_

class_: TOOLTIMELIMIT

Always 'ToolTimeLimit'

Optional extensionFields

extensionFields?: Dictionary<any>

loadingOptions

loadingOptions: LoadingOptions

timelimit

timelimit: string | number

The time limit, in seconds. A time limit of zero means no time limit. Negative time limits are an error.

Static attr

attr: Set<string> = ...

Methods

save

  • save(top?: boolean, baseUrl?: string, relativeUris?: boolean): Dictionary<any>

  • Parameters

    • top: boolean = false
    • baseUrl: string = ''
    • relativeUris: boolean = true

    Returns Dictionary<any>

Static fromDoc

  • fromDoc(__doc: any, baseuri: string, loadingOptions: LoadingOptions, docRoot?: string): Promise<Saveable>

  • Used to construct instances of .

    throws

    ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.

    Parameters

    • __doc: any

      Document fragment to load this record object from.

    • baseuri: string

      Base URI to generate child document IDs against.

    • loadingOptions: LoadingOptions

      Context for loading URIs and populating objects.

    • Optional docRoot: string

      ID at this position in the document (if available)

    Returns Promise<Saveable>

    An instance of

Generated using TypeDoc