Header  type: header#

class lumen.variables.base.Header(*, key, default, label, materialize, required, secure, value, name)#

Header variables reflect the value of a request header.


Parameters#

key

type: str
default: None
The request header to observe.


Methods#

Header.as_materialized() Constant#

If the variable is to be materialized by the builder this implements the conversion from a variable that references some external value to a materialized value.

Header.to_spec(context: Dict[str, Any] | None = None) Dict[str, Any]#

Exports the full specification to reconstruct this component.

Return type:

Resolved and instantiated Component object