Class KubernetesEnvironmentPropertySource

java.lang.Object

io.micronaut.context.env.MapPropertySource

io.micronaut.context.env.KubernetesEnvironmentPropertySource

All Implemented Interfaces:

PropertySource, Ordered, Iterable<String>

public class KubernetesEnvironmentPropertySource
extends MapPropertySource

A property source specific for the Kubernetes environment. It excludes Kubernetes-specific environment variables (like FOO_SERVICE_HOST, FOO_SERVICE_PORT, etc.) since they would slow down application startup

Since:

2.3.0

Author:

Nilson Pontello, Álvaro Sánchez-Mariscal

Nested Class Summary

Nested classes/interfaces inherited from interface PropertySource

PropertySource.Origin, PropertySource.PropertyConvention

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name of this property source.

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface PropertySource

CONTEXT

Constructor Summary

Constructors

Constructor	Description
KubernetesEnvironmentPropertySource()	Default constructor.
KubernetesEnvironmentPropertySource(@Nullable List<String> includes, @Nullable List<String> excludes)	Allows for control over which environment variables are included.

Method Summary

Modifier and Type	Method	Description
PropertySource.PropertyConvention	getConvention()
int	getOrder()
PropertySource.Origin	getOrigin()

Methods inherited from class MapPropertySource

asMap, get, getName, iterator, of, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Field Details

NAME

public static final String NAME

The name of this property source.

See Also:

• Constant Field Values

Constructor Details

KubernetesEnvironmentPropertySource

public KubernetesEnvironmentPropertySource()

Default constructor.

KubernetesEnvironmentPropertySource

public KubernetesEnvironmentPropertySource(@Nullable List<String> includes,
 @Nullable List<String> excludes)

Allows for control over which environment variables are included.

Parameters:

includes - The environment variables to include in configuration

excludes - The environment variables to exclude from configuration

Method Details

getOrigin

public PropertySource.Origin getOrigin()

Returns:

The origin of the property source.

getOrder

public int getOrder()

Returns:

The order of the object. Defaults to zero (no order).

getConvention

public PropertySource.PropertyConvention getConvention()

Returns:

Whether the property source has upper case underscore separated keys