Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Operation

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

This record describes an abstract operation. It is a potential step of a workflow that has not yet been bound to a concrete implementation. It specifies an input and output signature, but does not provide enough information to be executed. An implementation (or other tooling) may provide a means of binding an Operation to a concrete process (such as Workflow, CommandLineTool, or ExpressionTool) with a compatible signature.

Hierarchy

  • Saveable
    • Operation

Implements

Index

Constructors

constructor

Properties

class_

class_: OPERATION

Optional cwlVersion

cwlVersion?: CWLVersion

CWL document version. Always required at the document root. Not required for a Process embedded inside another Process.

Optional doc

doc?: string | string[]

A documentation string for this object, or an array of strings which should be concatenated.

Optional extensionFields

extensionFields?: Dictionary<any>

Optional hints

hints?: any[]

Declares hints applying to either the runtime environment or the workflow engine that may be helpful in executing this process. It is not an error if an implementation cannot satisfy all hints, however the implementation may report a warning.

Optional id

id?: string

The unique identifier for this object.

inputs

Defines the input parameters of the process. The process is ready to run when all required input parameters are associated with concrete values. Input parameters include a schema for each parameter which is used to validate the input object. It may also be used to build a user interface for constructing the input object.

When accepting an input object, all input parameters must have a value. If an input parameter is missing from the input object, it must be assigned a value of null (or the value of default for that parameter, if provided) for the purposes of validation and evaluation of expressions.

Optional intent

intent?: string[]

An identifier for the type of computational operation, of this Process. Especially useful for "class: Operation", but can also be used for CommandLineTool, Workflow, or ExpressionTool.

If provided, then this must be an IRI of a concept node that represents the type of operation, preferrably defined within an ontology.

For example, in the domain of bioinformatics, one can use an IRI from the EDAM Ontology's Operation concept nodes, like Alignment, or Clustering; or a more specific Operation concept like Split read mapping.

Optional label

label?: string

A short, human-readable label of this object.

loadingOptions

loadingOptions: LoadingOptions

outputs

Defines the parameters representing the output of the process. May be used to generate and/or validate the output object.

Optional requirements

Declares requirements that apply to either the runtime environment or the workflow engine that must be met in order to execute this process. If an implementation cannot satisfy all requirements, or a requirement is listed which is not recognized by the implementation, it is a fatal error and the implementation must not attempt to run the process, unless overridden at user option.

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