Packages > pkg.pkl-lang.org/pkl-readers/prometheus

prometheus.promql0.2.0

Properties
Methods
Classes
Type Aliases

module prometheus.promql

Module URI:: package://pkg.pkl-lang.org/pkl-readers/prometheus@0.2.0#/promql.pkl
Pkl version:: 0.30.0 or higher
Source code:: promql.pkl
Known subtypes in package:
Known usages in package:
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
isValid: (String) -> Boolean Source

A function that may be used as a type constraint to check if a String is valid PromQL query.
Equivalent to the result of isValidPromQLWithContext with a null context.

Example:
```
query: String(promethus.isValidPromQL)
```

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

function
isValidWithContext(context: String?): (String) -> Boolean Source

Returns a function that may be used as a type constraint to check if a String is valid PromQL query with the supplied context string.
Example:
```
alertName: String

query: String(promethus.isValidPromQLWithContext(alertName))
```

Classes

link

class

Parse extends Request Source

Parse a PromQL expression.

Type Aliases

link

typealias

Feature = "promql-experimental-functions"|"promql-duration-expr"|"promql-extended-range-selectors"|"promql-binop-fill-modifiers"|String Source

Supported PromQL feature flags.

Arbitrary strings are accepted to avoid breaking changes as upstream prometheus adds or removes flags for features.