QueryParameter

data class QueryParameter<Q : Any>(val name: String, val codec: StringCodec<Q>, val required: Boolean, val default: Q?) : Parameter<Q> (source)

Query parameter definition with optional default values.

Constructors

constructor(name: String, codec: StringCodec<Q>, required: Boolean, default: Q?)

Factory helpers for building QueryParameter definitions backed by common codecs.

open override val codec: StringCodec<Q>

Codec responsible for encoding and decoding parameter values.

optional fallback when the caller omits the query parameter. Optional parameters must supply a default.

open override val name: String

Canonical parameter name.

Location of the parameter within the HTTP request.

open override val required: Boolean

Indicates whether the parameter must be supplied by the caller.

Returns an optional version of this parameter with the supplied default value.