types

Documentation

Index

• func RawMessage(r *json.RawMessage) (raw json.RawMessage)
• type FlavorPlugin
• type InstancePlugin
• type Spec
  • func MustParse(s Spec, e error) Spec
  • func ParseProperties(config group.Spec) (Spec, error)
  • func (c Spec) InstanceHash() string

Functions

func RawMessage

func RawMessage(r *json.RawMessage) (raw json.RawMessage)

RawMessage converts a pointer to a raw message to a copy of the value. If the pointer is nil, it returns an empty raw message. This is useful for structs where fields are json.RawMessage pointers for bi-directional marshal and unmarshal (value receivers will encode base64 instead of raw json when marshaled), so bi-directional structs should use pointer fields.

Types

type FlavorPlugin

type FlavorPlugin struct {
	Plugin     string
	Properties *json.RawMessage // this will be the Spec of the plugin
}

FlavorPlugin describes the flavor configuration

type InstancePlugin

type InstancePlugin struct {
	Plugin     string
	Properties *json.RawMessage // this will be the Spec of the plugin
}

InstancePlugin is the structure that describes an instance plugin.

type Spec

type Spec struct {
	Instance InstancePlugin
	Flavor   FlavorPlugin
}

Spec is the configuration schema for the plugin, provided in group.Spec.Properties

func MustParse

func MustParse(s Spec, e error) Spec

MustParse can be wrapped over ParseProperties to panic if parsing fails.

func ParseProperties

func ParseProperties(config group.Spec) (Spec, error)

ParseProperties parses the group plugin properties JSON document in a group configuration.

func (Spec) InstanceHash

func (c Spec) InstanceHash() string

InstanceHash computes a stable hash of the document in InstancePluginProperties.