Packages > pkg.pkl-lang.org/pkl-pantry/k8s.networking.gateway > k8s.networking.gateway.v1beta1.HTTPRoute

QueryParam1.0.0

Properties
Methods

class QueryParam

HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters.

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

Properties

link

name: String(length.isBetween(1, 256), matches(Regex(#"^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$"#)))Source

Name is the name of the HTTP query param to be matched. This must be an exact string match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3).

If multiple entries specify equivalent query param names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent query param name MUST be ignored.

If a query param is repeated in an HTTP request, the behavior is purposely left undefined, since different data planes have different capabilities. However, it is recommended that implementations should match against the first value of the param if the data plane supports it, as this behavior is expected in other load balancing contexts outside of the Gateway API.

Users SHOULD NOT route traffic based on repeated query params to guard themselves against potential differences in the implementations.
link

type: ("Exact"|"RegularExpression")?Source

Type specifies how to match against the value of the query parameter.

Support: Extended (Exact)

Support: Implementation-specific (RegularExpression)

Since RegularExpression QueryParamMatchType has Implementation-specific conformance, implementations can support POSIX, PCRE or any other dialects of regular expressions. Please read the implementation's documentation to determine the supported dialect.

Default if undefined: "Exact"
link

value: String(length.isBetween(1, 1024))Source

Value is the value of HTTP query param to be matched.

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.