config

Documentation

Overview

Package config contains utilities for reading and parsing service configuration files.

Index

• func GetInferenceCandidates(raw interface{}, ignoreFields ...string) []string
• func MarshalYAML(v interface{}) ([]byte, error)
• type SanitForYAML
• type Sanitised
  • func SanitizeComponent(conf interface{}) (Sanitised, error)
  • func (s Sanitised) MarshalJSON() ([]byte, error)
  • func (s Sanitised) MarshalYAML() (interface{}, error)

Functions

func GetInferenceCandidates

func GetInferenceCandidates(raw interface{}, ignoreFields ...string) []string

GetInferenceCandidates checks a generic config structure (YAML or JSON) and, if an explicit type value is not found, returns a list of candidate types by walking the root objects field names.

func MarshalYAML

func MarshalYAML(v interface{}) ([]byte, error)

MarshalYAML marshals a structure into YAML with consistent formatting across all Benthos components.

Types

type SanitForYAML

type SanitForYAML map[string]interface{}

SanitForYAML a map to be embedded within a parent object for YAML marshalling.

type Sanitised

type Sanitised map[string]interface{}

Sanitised is a general map[string]interface{} type that tries to marshal into both YAML and JSON in a way that ensure the 'type' field is always first.

func SanitizeComponent

func SanitizeComponent(conf interface{}) (Sanitised, error)

SanitizeComponent performs a generic sanitation on a component config, where a type field describes the type of the component, and the only other fields returned in the sanitized result are under the namespace of the type.

func (Sanitised) MarshalJSON

func (s Sanitised) MarshalJSON() ([]byte, error)

MarshalJSON return the config as a JSON blob with the 'type' field first.

func (Sanitised) MarshalYAML

func (s Sanitised) MarshalYAML() (interface{}, error)

MarshalYAML return the config as YAML with the 'type' field first.