v1

Documentation

Index

• Constants
• Variables
• type ConnectorSpecification
  • func (c ConnectorSpecification) FromConfig(spec pconnector.Specification) ConnectorSpecification
  • func (c ConnectorSpecification) ToConfig() (pconnector.Specification, error)
• type Destination
  • func (d Destination) ToConfig() (config.Parameters, error)
• type Parameter
  • func (p Parameter) FromConfig(param config.Parameter) Parameter
  • func (p Parameter) ToConfig() (config.Parameter, error)
• type ParameterType
  • func (ParameterType) FromConfig(t config.ParameterType) ParameterType
  • func (t ParameterType) ToConfig() (config.ParameterType, error)
• type Parameters
  • func (Parameters) FromConfig(params config.Parameters) Parameters
  • func (p Parameters) ToConfig() (config.Parameters, error)
• type Source
  • func (s Source) ToConfig() (config.Parameters, error)
• type Specification
  • func (s Specification) FromConfig(spec pconnector.Specification) Specification
  • func (s Specification) ToConfig() (pconnector.Specification, error)
• type Validation
  • func (v Validation) FromConfig(validation config.Validation) Validation
  • func (v Validation) ToConfig() (config.Validation, error)
• type Validations
  • func (Validations) FromConfig(v []config.Validation) Validations
  • func (v Validations) ToConfig() ([]config.Validation, error)

Constants

const LatestVersion = "1.0"

Variables

var Changelog = evolviconf.Changelog{
	semver.MustParse("1.0"): {},
}

Changelog should be adjusted every time we change the specification and add a new config version. Based on the changelog the parser will output warnings.

Types

type ConnectorSpecification

type ConnectorSpecification struct {
	Name        string `json:"name" yaml:"name"`
	Summary     string `json:"summary" yaml:"summary"`
	Description string `json:"description" yaml:"description"`
	Version     string `json:"version" yaml:"version"`
	Author      string `json:"author" yaml:"author"`

	Source      Source      `json:"source,omitempty" yaml:"source,omitempty"`
	Destination Destination `json:"destination,omitempty" yaml:"destination,omitempty"`
}

func (ConnectorSpecification) FromConfig

func (c ConnectorSpecification) FromConfig(spec pconnector.Specification) ConnectorSpecification

func (ConnectorSpecification) ToConfig

func (c ConnectorSpecification) ToConfig() (pconnector.Specification, error)

type Destination

type Destination struct {
	Parameters Parameters `json:"parameters,omitempty" yaml:"parameters,omitempty"`
}

func (Destination) ToConfig

func (d Destination) ToConfig() (config.Parameters, error)

type Parameter

type Parameter struct {
	Name        string        `json:"name"`
	Description string        `json:"description"`
	Type        ParameterType `json:"type"`
	Default     string        `json:"default"`
	Validations Validations   `json:"validations,omitempty"`
}

func (Parameter) FromConfig

func (p Parameter) FromConfig(param config.Parameter) Parameter

func (Parameter) ToConfig

func (p Parameter) ToConfig() (config.Parameter, error)

type ParameterType

type ParameterType string

func (ParameterType) FromConfig

func (ParameterType) FromConfig(t config.ParameterType) ParameterType

func (ParameterType) ToConfig

func (t ParameterType) ToConfig() (config.ParameterType, error)

type Parameters

type Parameters []Parameter

func (Parameters) FromConfig

func (Parameters) FromConfig(params config.Parameters) Parameters

func (Parameters) ToConfig

func (p Parameters) ToConfig() (config.Parameters, error)

type Source

type Source struct {
	Parameters Parameters `json:"parameters,omitempty" yaml:"parameters,omitempty"`
}

func (Source) ToConfig

func (s Source) ToConfig() (config.Parameters, error)

type Specification

type Specification struct {
	Version                string                 `json:"version" yaml:"version"`
	ConnectorSpecification ConnectorSpecification `json:"specification" yaml:"specification"`
}

func (Specification) FromConfig

func (s Specification) FromConfig(spec pconnector.Specification) Specification

func (Specification) ToConfig

func (s Specification) ToConfig() (pconnector.Specification, error)

ToConfig implements evolviconf.VersionedConfig.

type Validation

type Validation struct {
	Type  string `json:"type"`
	Value string `json:"value"`
}

func (Validation) FromConfig

func (v Validation) FromConfig(validation config.Validation) Validation

func (Validation) ToConfig

func (v Validation) ToConfig() (config.Validation, error)

type Validations

type Validations []Validation

func (Validations) FromConfig

func (Validations) FromConfig(v []config.Validation) Validations

func (Validations) ToConfig

func (v Validations) ToConfig() ([]config.Validation, error)