envconfig

Documentation

Overview

Copyright 2021 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func GetEnvBool(key string, defaultValue bool, log logr.Logger) bool
• func GetEnvDuration(key string, defaultValue time.Duration, log logr.Logger) time.Duration
• func GetEnvFloat(key string, defaultValue float64, log logr.Logger) float64
• func GetEnvInt(key string, defaultValue int, log logr.Logger) int
• func GetEnvInt32(key string, defaultValue int32, log logr.Logger) int32
• func GetEnvString(key string, defaultValue string) string

Functions

func GetEnvBool

func GetEnvBool(key string, defaultValue bool, log logr.Logger) bool

Returns the bool value of environment variable "key" or the default value if "key" is not set. Note if the environment variable is set to a non boolean, including an empty string, this will fail and exit.

func GetEnvDuration

func GetEnvDuration(key string, defaultValue time.Duration, log logr.Logger) time.Duration

Returns the duration value of environment variable "key" or a default value Note if the environment variable cannot be parsed as a duration, including an empty string, this will fail and exit.

func GetEnvFloat

func GetEnvFloat(key string, defaultValue float64, log logr.Logger) float64

func GetEnvInt

func GetEnvInt(key string, defaultValue int, log logr.Logger) int

Returns the integer of value environment variable "key" or the default value if "key" is not set. Note if the environment variable is set to a non integer, including an empty string, this will fail and exit.

func GetEnvInt32

func GetEnvInt32(key string, defaultValue int32, log logr.Logger) int32

func GetEnvString

func GetEnvString(key string, defaultValue string) string

Returns the string value of environment variable "key" or the default value if "key" is not set. Note if the environment variable is set to an empty string, this will return an empty string, not defaultValue.