Pkldoc > schema.kdeps.com/core

org.kdeps.pkl.Workflow0.2.17

Overview
Properties
Methods

open module org.kdeps.pkl.Workflow

Abstractions for Kdeps Workflow Management

Module URI:: package://schema.kdeps.com/core@0.2.17#/deps/pkl/Workflow.pkl
Pkl version:: 0.28.1 or higher
Source code:: Workflow.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

hidden

nameStringRegex: unknownSource

Regex pattern for validating workflow names (alphanumeric characters only).
link

hidden

actionStringRegex: unknownSource

Regex pattern for validating actions (alphanumeric or @package/action:version).
link

hidden

workflowStringRegex: unknownSource

Regex pattern for validating workflows (@package/action:version).
link

hidden

versionStringRegex: unknownSource

Regex pattern for validating version numbers (e.g., 1.0.0, 2.1).
link

hidden

isValidName: unknownSource

Checks if the provided name is valid (alphanumeric only).

Throws an error if the name contains invalid characters.
link

hidden

isValidWorkflow: unknownSource

Validates the format of a workflow reference string.

The workflow must start with @, followed by a package name, and optionally a path segment and version.
link

hidden

isValidAction: unknownSource

Validates the format of an action string.

The action must be either alphanumeric or follow the @package/action:version format.
link

hidden

isValidVersion: unknownSource

Validates the format of the version string.

The version must follow the semantic versioning pattern (major.minor.patch).
link

name: String(isValidName)Source

The name of the workflow, validated to contain only alphanumeric characters.
link

description: String Source

A description of the workflow, providing details about its purpose and behavior.
link

website: Uri?Source

A URI pointing to the website or landing page for the workflow, if available.
link

authors: Listing<String>?Source

A listing of the authors or contributors to the workflow.
link

documentation: Uri?Source

A URI pointing to the documentation for the workflow, if available.
link

repository: Uri?Source

A URI pointing to the repository where the workflow's code or configuration can be found.
link

heroImage: String?Source

Hero image to be used on this AI Agent.
link

agentIcon: String?Source

The icon to be used on this AI agent.
link

version: String(isValidVersion)Source

The version of the workflow, following semantic versioning rules (e.g., 1.0.0).
link

targetActionID: String(isValidAction)Source

The default action to be performed by the workflow, validated to ensure proper formatting.
link

workflows: Listing<String(isValidWorkflow)>Source

A listing of external workflows referenced by this workflow, validated by format.
link

settings: Settings Source

The project settings that this workflow depends on.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```