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

Parse0.2.0

Properties
Methods

class Parse extends Request

Parse a PromQL expression.

Known subtypes in package:
Known usages in package:
All versions:

Properties(show inherited)

link

kind: String Source
link

hidden

Request.requestUri: URI (prometheus.prometheus)
link

query: String Source

PromQL query to parse.
link

enableFeatures: Listing<Feature>(isDistinct)Source

Prometheus feature flags to enable.

Feature documents supported features. Unrecognized features result in a warning and are ignored.
link

hidden

parseError: String Source

Resulting error message from parsing query.

Empty string if no parse error occurrs.
link

hidden

isValid: Boolean Source

Indicates if query is valid PromQL.

Empty queries are always valid.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.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

Any.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

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

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

function

Typed.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

Typed.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

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function

check(context: String?): Boolean Source

Check if query is valid PromQL and throw an error if it is not.

The context provides additional user-supplied context to help identify invalid queries. If it is not null, it is included in the thrown error's message.