config

package

v0.0.0-...-c325cbb Latest Latest Go to latest Published: May 1, 2024 License: AGPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func KnownConfigKeys(schema environschema.Fields) set.Strings

KnownConfigKeys returns the valid config keys.

type Config struct {
	// contains filtered or unexported fields
}

Config encapsulates config for an entity.

func NewConfig(attrs map[string]interface{}, schema environschema.Fields, defaults schema.Defaults) (*Config, error)

NewConfig returns a new config instance with the given attributes and allowing for the extra provider attributes.

func (c *Config) Attributes() ConfigAttributes

Attributes returns all the config attributes.

func (c *Config) Validate() error

Validate returns an error if the config is not valid.

type ConfigAttributes map[string]interface{}

ConfigAttributes represents config for an entity.

func (c ConfigAttributes) Get(attrName string, defaultValue interface{}) interface{}

Get gets the specified attribute.

func (c ConfigAttributes) GetBool(attrName string, defaultValue bool) bool

GetBool gets the specified bool attribute.

func (c ConfigAttributes) GetInt(attrName string, defaultValue int) int

GetInt gets the specified int attribute.

func (c ConfigAttributes) GetString(attrName string, defaultValue string) string

GetString gets the specified string attribute.

func (c ConfigAttributes) GetStringMap(attrName string, defaultValue map[string]string) (map[string]string, error)

GetStringMap gets the specified map attribute as map[string]string.