persistence

Documentation

Index

• Constants
• func GetTopLevelDefinitionYamlTypeName() string
• type AutomationDefinition
• type ComplexApiDefinition
• type ConfigDefinition
• type ConfigParameter
• type DocumentDefinition
• type EnvironmentOverride
• type GroupOverride
• type OpenPipelineDefinition
• type SettingsDefinition
• type TopLevelConfigDefinition
• type TopLevelDefinition
• type TypeDefinition
  • func (c *TypeDefinition) GetApiType() string
  • func (c TypeDefinition) MarshalYAML() (interface{}, error)
  • func (c *TypeDefinition) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (c *TypeDefinition) Validate(apis map[string]struct{}) error

Constants

const BucketType = "bucket"

Functions

func GetTopLevelDefinitionYamlTypeName

func GetTopLevelDefinitionYamlTypeName() string

Types

type AutomationDefinition

type AutomationDefinition struct {
	Resource config.AutomationResource `` /* 182-byte string literal not displayed */
}

type ComplexApiDefinition

type ComplexApiDefinition struct {
	Name  string          `yaml:"name" json:"name" jsonschema:"required,description=The name of the API the config is for." mapstructure:"name"`
	Scope ConfigParameter `` /* 145-byte string literal not displayed */
}

type ConfigDefinition

type ConfigDefinition struct {
	Name           ConfigParameter            `` /* 140-byte string literal not displayed */
	Parameters     map[string]ConfigParameter `yaml:"parameters,omitempty" json:"parameters,omitempty" jsonschema:"description=Parameters for this configuration."`
	Template       string                     `` /* 147-byte string literal not displayed */
	Skip           ConfigParameter            `` /* 130-byte string literal not displayed */
	OriginObjectId string                     `` /* 260-byte string literal not displayed */
}

type ConfigParameter

type ConfigParameter interface{}

type DocumentDefinition

type DocumentDefinition struct {
	Kind    config.DocumentKind `` /* 160-byte string literal not displayed */
	Private bool                `` /* 139-byte string literal not displayed */
}

type EnvironmentOverride

type EnvironmentOverride struct {
	Environment string           `yaml:"environment" json:"environment" jsonschema:"required,description=Name of the environment this override applies for."`
	Override    ConfigDefinition `` /* 170-byte string literal not displayed */
}

type GroupOverride

type GroupOverride struct {
	Group    string           `yaml:"group" json:"group" jsonschema:"required,description=Name of the group this override applies for."`
	Override ConfigDefinition `` /* 183-byte string literal not displayed */
}

type OpenPipelineDefinition

type OpenPipelineDefinition struct {
	Kind string `` /* 135-byte string literal not displayed */
}

type SettingsDefinition

type SettingsDefinition struct {
	Schema        string          `yaml:"schema,omitempty" json:"schema,omitempty" jsonschema:"required,description=The Settings 2.0 schema of this config."`
	SchemaVersion string          `` /* 184-byte string literal not displayed */
	Scope         ConfigParameter `` /* 134-byte string literal not displayed */
	InsertAfter   ConfigParameter `` /* 199-byte string literal not displayed */
}

type TopLevelConfigDefinition

type TopLevelConfigDefinition struct {
	Id     string           `` /* 169-byte string literal not displayed */
	Config ConfigDefinition `yaml:"config" json:"config" jsonschema:"required,description=The actual configuration to be applied"`
	Type   TypeDefinition   `` /* 158-byte string literal not displayed */
	// GroupOverrides overwrite specific parts of the Config when deploying it to any environment in a given group
	GroupOverrides []GroupOverride `` /* 197-byte string literal not displayed */
	// EnvironmentOverrides overwrite specific parts of the Config when deploying it to a given environment
	EnvironmentOverrides []EnvironmentOverride `` /* 202-byte string literal not displayed */
}

type TopLevelDefinition

type TopLevelDefinition struct {
	Configs []TopLevelConfigDefinition `` /* 142-byte string literal not displayed */
}

type TypeDefinition

type TypeDefinition struct {
	Type        config.Type
	Scope       ConfigParameter
	InsertAfter ConfigParameter
}

func (*TypeDefinition) GetApiType

func (c *TypeDefinition) GetApiType() string

func (TypeDefinition) MarshalYAML

func (c TypeDefinition) MarshalYAML() (interface{}, error)

func (*TypeDefinition) UnmarshalYAML

func (c *TypeDefinition) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML Custom unmarshaler that knows how to handle TypeDefinition. 'type' section can come as string or as struct as it is defind in `TypeDefinition` function parameter more than once if necessary.

func (*TypeDefinition) Validate

func (c *TypeDefinition) Validate(apis map[string]struct{}) error

Validate verifies whether the given type definition is valid (correct APIs, fields set, etc)