docs

package

Go to main page

Versions in this module

v4

v4.42.0

Nov 29, 2024

v4.41.1

Nov 25, 2024

v4.41.0

Nov 20, 2024

v4.40.0

Oct 25, 2024

v4.39.0

Oct 14, 2024

Changes in this version

type FieldSpec

+ func (f FieldSpec) WalkComponentsAny(conf WalkComponentConfig, value any) error

type FieldSpecs

+ func (f FieldSpecs) WalkComponentsAny(conf WalkComponentConfig, m any) error

type WalkedComponent

+ func (w WalkedComponent) WalkComponents(fn WalkComponentFunc) error

v4.38.0

Sep 17, 2024

v4.37.0

Sep 11, 2024

v4.36.0

Aug 29, 2024

v4.35.0

Aug 13, 2024

v4.34.0

Aug 6, 2024

Changes in this version

+ var ErrSkipChildComponents = errors.New("skip children")

type FieldSpec

+ func (f FieldSpec) WalkComponentsYAML(conf WalkComponentConfig, node *yaml.Node) error

type FieldSpecs

+ func (f FieldSpecs) WalkComponentsYAML(conf WalkComponentConfig, node *yaml.Node) error

+ type WalkComponentConfig struct

+ Func WalkComponentFunc

+ Provider Provider

+ type WalkComponentFunc func(c WalkedComponent) error

+ type WalkedComponent struct

+ Field FieldSpec

+ Label string

+ LineEnd int

+ LineStart int

+ Name string

+ Path string

+ Value *yaml.Node

+ func (w WalkedComponent) WalkComponentsYAML(fn WalkComponentFunc) error

v4.33.0

Jul 19, 2024

v4.32.0

Jul 16, 2024

v4.31.0

Jul 10, 2024

v4.30.0

Jun 13, 2024

v4.29.0

Jun 10, 2024

Changes in this version

+ var DeprecatedComponentTemplate = ...

+ func DeprecatedFieldsTemplate(lintableExamples bool) string

type ComponentSpec

+ SupportLevel string

v4.28.1

May 30, 2024

v4.28.0

May 29, 2024

Changes in this version

+ var ErrBadLabel = fmt.Errorf(...)

+ func BloblangFunctionsMarkdown() ([]byte, error)

+ func BloblangMethodsMarkdown() ([]byte, error)

+ func ComponentFieldsFromConf(conf any) (inferred map[string]FieldSpecs)

+ func FieldsTemplate(lintableExamples bool) string

+ func GetPluginConfigYAML(name string, node *yaml.Node) (yaml.Node, error)

+ func GetYAMLPath(root *yaml.Node, path ...string) (*yaml.Node, error)

+ func MarshalYAML(v yaml.Node) ([]byte, error)

+ func ReservedFieldsByType(t Type) map[string]FieldSpec

+ func SanitiseYAML(cType Type, node *yaml.Node, conf SanitiseConfig) error

+ func UnmarshalYAML(rawBytes []byte) (*yaml.Node, error)

+ func ValidateLabel(label string) error

+ type AnnotatedExample struct

+ Config string

+ Summary string

+ Title string

+ type ComponentSpec struct

+ Categories []string

+ Config FieldSpec

+ Description string

+ Examples []AnnotatedExample

+ Footnotes string

+ Name string

+ Plugin bool

+ Status Status

+ Summary string

+ Type Type

+ Version string

+ func GetInferenceCandidateFromMap(docProv Provider, t Type, m map[string]any) (string, ComponentSpec, error)

+ func GetInferenceCandidateFromYAML(docProv Provider, t Type, node *yaml.Node) (string, ComponentSpec, error)

+ func (c *ComponentSpec) AsMarkdown(prov Provider, nest bool, fullConfigExample any) ([]byte, error)

+ type ComponentWalkYAMLFunc func(c WalkedYAMLComponent) error

+ type FieldFilter func(spec FieldSpec, v any) bool

+ func ShouldDropDeprecated(b bool) FieldFilter

+ type FieldKind string

+ var Kind2DArray FieldKind = "2darray"

+ var KindArray FieldKind = "array"

+ var KindMap FieldKind = "map"

+ var KindScalar FieldKind = "scalar"

+ type FieldSpec struct

+ AnnotatedOptions [][2]string

+ Bloblang bool

+ Children FieldSpecs

+ Default *any

+ Description string

+ Examples []any

+ Interpolated bool

+ IsAdvanced bool

+ IsDeprecated bool

+ IsOptional bool

+ IsSecret bool

+ Kind FieldKind

+ Linter string

+ Name string

+ Options []string

+ Scrubber string

+ Type FieldType

+ Version string

+ func FieldAnything(name, description string, examples ...any) FieldSpec

+ func FieldBloblang(name, description string, examples ...any) FieldSpec

+ func FieldBool(name, description string, examples ...any) FieldSpec

+ func FieldBuffer(name, description string, examples ...any) FieldSpec

+ func FieldCache(name, description string, examples ...any) FieldSpec

+ func FieldComponent() FieldSpec

+ func FieldFloat(name, description string, examples ...any) FieldSpec

+ func FieldFromYAML(name string, node *yaml.Node) FieldSpec

+ func FieldInput(name, description string, examples ...any) FieldSpec

+ func FieldInt(name, description string, examples ...any) FieldSpec

+ func FieldInterpolatedString(name, description string, examples ...any) FieldSpec

+ func FieldMetrics(name, description string, examples ...any) FieldSpec

+ func FieldObject(name, description string, examples ...any) FieldSpec

+ func FieldOutput(name, description string, examples ...any) FieldSpec

+ func FieldProcessor(name, description string, examples ...any) FieldSpec

+ func FieldRateLimit(name, description string, examples ...any) FieldSpec

+ func FieldScanner(name, description string, examples ...any) FieldSpec

+ func FieldString(name, description string, examples ...any) FieldSpec

+ func FieldTracer(name, description string, examples ...any) FieldSpec

+ func FieldURL(name, description string, examples ...any) FieldSpec

+ func MetricsMappingFieldSpec(name string) FieldSpec

+ func (f FieldSpec) Advanced() FieldSpec

+ func (f FieldSpec) AnyToValue(v any, conf ToValueConfig) (any, error)

+ func (f FieldSpec) Array() FieldSpec

+ func (f FieldSpec) ArrayOfArrays() FieldSpec

+ func (f FieldSpec) AtVersion(v string) FieldSpec

+ func (f FieldSpec) CheckRequired() bool

+ func (f FieldSpec) ChildDefaultAndTypesFromStruct(conf any) FieldSpec

+ func (f FieldSpec) DefaultAndTypeFrom(from FieldSpec) FieldSpec

+ func (f FieldSpec) Deprecated() FieldSpec

+ func (f FieldSpec) FlattenChildrenForDocs() []FieldSpecCtx

+ func (f FieldSpec) GetDocsForPath(docsProvider Provider, path ...string) (FieldSpec, error)

+ func (f FieldSpec) GetLintFunc() LintFunc

+ func (f FieldSpec) HasAnnotatedOptions(options ...string) FieldSpec

+ func (f FieldSpec) HasDefault(v any) FieldSpec

+ func (f FieldSpec) HasOptions(options ...string) FieldSpec

+ func (f FieldSpec) HasType(t FieldType) FieldSpec

+ func (f FieldSpec) IsBloblang() FieldSpec

+ func (f FieldSpec) IsInterpolated() FieldSpec

+ func (f FieldSpec) JSONSchema() any

+ func (f FieldSpec) LintYAML(ctx LintContext, node *yaml.Node) []Lint

+ func (f FieldSpec) LinterBlobl(blobl string) FieldSpec

+ func (f FieldSpec) LinterFunc(fn LintFunc) FieldSpec

+ func (f FieldSpec) Map() FieldSpec

+ func (f FieldSpec) OmitWhen(fn func(field, parent any) (why string, shouldOmit bool)) FieldSpec

+ func (f FieldSpec) Optional() FieldSpec

+ func (f FieldSpec) ParsedConfigFromAny(v any) (pConf *ParsedConfig, err error)

+ func (f FieldSpec) SanitiseYAML(node *yaml.Node, conf SanitiseConfig) error

+ func (f FieldSpec) Scalar() FieldSpec

+ func (f FieldSpec) ScrubValue(v any) (any, error)

+ func (f FieldSpec) Secret() FieldSpec

+ func (f FieldSpec) SetYAMLPath(docsProvider Provider, root, value *yaml.Node, path ...string) error

+ func (f FieldSpec) ToYAML(recurse bool) (*yaml.Node, error)

+ func (f FieldSpec) WalkYAML(node *yaml.Node, prov Provider, fn ComponentWalkYAMLFunc) error

+ func (f FieldSpec) WithChildren(children ...FieldSpec) FieldSpec

+ func (f FieldSpec) YAMLLabelsToPaths(docsProvider Provider, node *yaml.Node, labelsToPaths map[string][]string, ...)

+ func (f FieldSpec) YAMLToValue(node *yaml.Node, conf ToValueConfig) (any, error)

+ type FieldSpecCtx struct

+ DefaultMarshalled string

+ ExamplesMarshalled []string

+ FullName string

+ Spec FieldSpec

+ type FieldSpecs []FieldSpec

+ func FieldsFromConf(conf any) FieldSpecs

+ func FieldsFromYAML(node *yaml.Node) FieldSpecs

+ func (f FieldSpecs) Add(specs ...FieldSpec) FieldSpecs

+ func (f FieldSpecs) AnyToMap(v any, conf ToValueConfig) (map[string]any, error)

+ func (f FieldSpecs) DefaultAndTypeFrom(from FieldSpecs) FieldSpecs

+ func (f FieldSpecs) GetDocsForPath(docsProvider Provider, path ...string) (FieldSpec, error)

+ func (f FieldSpecs) JSONSchema() map[string]any

+ func (f FieldSpecs) LintYAML(ctx LintContext, node *yaml.Node) []Lint

+ func (f FieldSpecs) Merge(specs FieldSpecs) FieldSpecs

+ func (f FieldSpecs) ParsedConfigFromAny(v any) (pConf *ParsedConfig, err error)

+ func (f FieldSpecs) SanitiseYAML(node *yaml.Node, conf SanitiseConfig) error

+ func (f FieldSpecs) SetDefault(v any, path ...string)

+ func (f FieldSpecs) SetYAMLPath(docsProvider Provider, root, value *yaml.Node, path ...string) error

+ func (f FieldSpecs) ToYAML() (*yaml.Node, error)

+ func (f FieldSpecs) WalkYAML(node *yaml.Node, prov Provider, fn ComponentWalkYAMLFunc) error

+ func (f FieldSpecs) YAMLLabelsToPaths(docsProvider Provider, node *yaml.Node, labelsToPaths map[string][]string, ...)

+ func (f FieldSpecs) YAMLToMap(node *yaml.Node, conf ToValueConfig) (map[string]any, error)

+ type FieldType string

+ var FieldTypeBool FieldType = "bool"

+ var FieldTypeBuffer FieldType = "buffer"

+ var FieldTypeCache FieldType = "cache"

+ var FieldTypeFloat FieldType = "float"

+ var FieldTypeInput FieldType = "input"

+ var FieldTypeInt FieldType = "int"

+ var FieldTypeMetrics FieldType = "metrics"

+ var FieldTypeObject FieldType = "object"

+ var FieldTypeOutput FieldType = "output"

+ var FieldTypeProcessor FieldType = "processor"

+ var FieldTypeRateLimit FieldType = "rate_limit"

+ var FieldTypeScanner FieldType = "scanner"

+ var FieldTypeString FieldType = "string"

+ var FieldTypeTracer FieldType = "tracer"

+ var FieldTypeUnknown FieldType = "unknown"

+ func (t FieldType) IsCoreComponent() (Type, bool)

+ type Lint struct

+ Column int

+ Level LintLevel

+ Line int

+ Type LintType

+ What string

+ func LintBloblangField(ctx LintContext, line, col int, v any) []Lint

+ func LintBloblangMapping(ctx LintContext, line, col int, v any) []Lint

+ func LintYAML(ctx LintContext, cType Type, node *yaml.Node) []Lint

+ func NewLintError(line int, t LintType, err error) Lint

+ func NewLintWarning(line int, t LintType, msg string) Lint

+ func (l Lint) Error() string

+ type LintConfig struct

+ BloblangEnv *bloblang.Environment

+ DocsProvider Provider

+ RejectDeprecated bool

+ RequireLabels bool

+ func NewLintConfig(prov Provider) LintConfig

+ type LintContext struct

+ func NewLintContext(conf LintConfig) LintContext

+ type LintFunc func(ctx LintContext, line, col int, value any) []Lint

+ type LintLevel int

+ const LintError

+ const LintWarning

+ type LintType int

+ const LintBadBloblang

+ const LintBadLabel

+ const LintComponentMissing

+ const LintComponentNotFound

+ const LintCustom

+ const LintDeprecated

+ const LintDuplicateLabel

+ const LintExpectedArray

+ const LintExpectedObject

+ const LintExpectedScalar

+ const LintFailedRead

+ const LintInvalidOption

+ const LintMissing

+ const LintMissingEnvVar

+ const LintMissingLabel

+ const LintShouldOmit

+ const LintUnknown

+ type MappedDocsProvider struct

+ func NewMappedDocsProvider() *MappedDocsProvider

+ func (m *MappedDocsProvider) Clone() *MappedDocsProvider

+ func (m *MappedDocsProvider) GetDocs(name string, ctype Type) (ComponentSpec, bool)

+ func (m *MappedDocsProvider) RegisterDocs(spec ComponentSpec)

+ type ParsedConfig struct

+ func (p *ParsedConfig) Contains(path ...string) bool

+ func (p *ParsedConfig) Field(path ...string) (any, bool)

+ func (p *ParsedConfig) FieldAny(path ...string) (any, error)

+ func (p *ParsedConfig) FieldAnyList(path ...string) ([]*ParsedConfig, error)

+ func (p *ParsedConfig) FieldAnyMap(path ...string) (map[string]*ParsedConfig, error)

+ func (p *ParsedConfig) FieldBool(path ...string) (bool, error)

+ func (p *ParsedConfig) FieldDuration(path ...string) (time.Duration, error)

+ func (p *ParsedConfig) FieldFloat(path ...string) (float64, error)

+ func (p *ParsedConfig) FieldFloatList(path ...string) ([]float64, error)

+ func (p *ParsedConfig) FieldFloatMap(path ...string) (map[string]float64, error)

+ func (p *ParsedConfig) FieldInt(path ...string) (int, error)

+ func (p *ParsedConfig) FieldIntList(path ...string) ([]int, error)

+ func (p *ParsedConfig) FieldIntMap(path ...string) (map[string]int, error)

+ func (p *ParsedConfig) FieldObjectList(path ...string) ([]*ParsedConfig, error)

+ func (p *ParsedConfig) FieldObjectListOfLists(path ...string) ([][]*ParsedConfig, error)

+ func (p *ParsedConfig) FieldObjectMap(path ...string) (map[string]*ParsedConfig, error)

+ func (p *ParsedConfig) FieldString(path ...string) (string, error)

+ func (p *ParsedConfig) FieldStringList(path ...string) ([]string, error)

+ func (p *ParsedConfig) FieldStringListOfLists(path ...string) ([][]string, error)

+ func (p *ParsedConfig) FieldStringMap(path ...string) (map[string]string, error)

+ func (p *ParsedConfig) FullDotPath(path ...string) string

+ func (p *ParsedConfig) Line() (int, bool)

+ func (p *ParsedConfig) Namespace(path ...string) *ParsedConfig

+ func (p *ParsedConfig) Raw() any

+ type Provider interface

+ GetDocs func(name string, ctype Type) (ComponentSpec, bool)

+ type SanitiseConfig struct

+ DocsProvider Provider

+ Filter FieldFilter

+ ForExample bool

+ RemoveDeprecated bool

+ RemoveTypeField bool

+ ScrubSecrets bool

+ func NewSanitiseConfig(prov Provider) SanitiseConfig

+ type Status string

+ var StatusBeta Status = "beta"

+ var StatusDeprecated Status = "deprecated"

+ var StatusExperimental Status = "experimental"

+ var StatusStable Status = "stable"

+ type ToValueConfig struct

+ FallbackToAny bool

+ Passive bool

+ type Type string

+ var TypeBuffer Type = "buffer"

+ var TypeCache Type = "cache"

+ var TypeInput Type = "input"

+ var TypeMetrics Type = "metrics"

+ var TypeOutput Type = "output"

+ var TypeProcessor Type = "processor"

+ var TypeRateLimit Type = "rate_limit"

+ var TypeScanner Type = "scanner"

+ var TypeTracer Type = "tracer"

+ func Types() []Type

+ type WalkedYAMLComponent struct

+ ComponentType Type

+ Conf *yaml.Node

+ Label string

+ Name string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL