Pkldoc > schema.kdeps.com/core

org.kdeps.pkl.Resource0.2.17

Overview
Properties
Methods
Classes

module org.kdeps.pkl.Resource

Abstractions for Kdeps Resources

Module URI:: package://schema.kdeps.com/core@0.2.17#/deps/pkl/Resource.pkl
Pkl version:: 0.28.1 or higher
Source code:: Resource.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

actionStringRegex: unknownSource

Regex pattern for validating resource actionIDs and dependencies.
link

hidden

isValidActionID: unknownSource

Validates the resource actionID according to the specified regex pattern.

Throws an error if the resource actionID contains invalid characters.

str: The resource actionID to validate.
link

hidden

isValidDependency: unknownSource

Validates the dependency actionID according to the specified regex pattern.

Throws an error if the dependency actionID contains invalid characters.

str: The dependency actionID to validate.
link

actionID: String(isValidActionID)Source

The unique identifier for the resource, validated against isValidActionID.
link

name: String Source

The name of the resource.
link

description: String Source

A description of the resource, providing additional context.
link

category: String Source

The category to which the resource belongs.
link

requires: Listing<String(isValidDependency)>?Source

A listing of dependencies required by the resource, validated against isValidDependency.
link

run: ResourceAction Source

Defines the action to be taken for the resource.

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)
```

Classes

link

class

ResourceAction Source

Class representing an action that can be executed on a resource.
link

class

ValidationCheck Source

Class representing validation checks that can be performed on actions.
link

class

APIError Source

Class representing an error returned from an API validation check.