http4k-config/org.http4k.config/EnvironmentKey

EnvironmentKey

object EnvironmentKey : BiDiLensSpec<Environment, String>

This models the key used to get a value out of the Environment using the standard Lens mechanic. Note that if your values contain commas, either use a EnvironmentKey.(mapping).multi.required()/optional()/defaulted() to retrieve the entire list, or override the comma separator in your initial Environment.

Types

k8s

object k8s

Properties

location

val location: String

multi

open override val multi: BiDiMultiLensSpec<Environment, String>

Functions

authority

fun <IN : Any> BiDiLensSpec<IN, String>.authority(): BiDiLensSpec<IN, Authority>

defaulted

open override fun defaulted(name: String, default: String, description: String?, metadata: Map<String, Any>): BiDiLens<Environment, String>

open override fun defaulted(name: String, default: LensExtractor<Environment, String>, description: String?, metadata: Map<String, Any>): BiDiLens<Environment, String>

enum

inline fun <T : Enum<T>> EnvironmentKey.enum(caseSensitive: Boolean = true): BiDiLensSpec<Environment, T>

host

fun <IN : Any> BiDiLensSpec<IN, String>.host(): BiDiLensSpec<IN, Host>

map

fun <NEXT> map(nextIn: (String) -> NEXT, nextOut: (NEXT) -> String): BiDiLensSpec<Environment, NEXT>

fun <NEXT> map(nextIn: (String) -> NEXT): LensSpec<Environment, NEXT>

mapWithNewMeta

fun <NEXT> mapWithNewMeta(nextIn: (String) -> NEXT, nextOut: (NEXT) -> String, paramMeta: ParamMeta): BiDiLensSpec<Environment, NEXT>

optional

open override fun optional(name: String, description: String?, metadata: Map<String, Any>): BiDiLens<Environment, String?>

port

fun <IN : Any> BiDiLensSpec<IN, String>.port(): BiDiLensSpec<IN, Port>

required

open override fun required(name: String, description: String?, metadata: Map<String, Any>): BiDiLens<Environment, String>

secret

fun <IN : Any> BiDiLensSpec<IN, String>.secret(): BiDiLensSpec<IN, Secret>

timeout

fun <IN : Any> BiDiLensSpec<IN, String>.timeout(): BiDiLensSpec<IN, Timeout>