parameter

type Parameter interface {
	// GetType returns the type of the parameter.
	GetType() string

	// GetReferences returns a slice of all other parameters this parameter references.
	// this is need in the sorting phase to first deploy references, so that
	// they an be resolved during deployment phase.
	GetReferences() []ParameterReference

	// ResolveValue resolves the value of this parameter. the context offers some more information
	// on the current deployment and resolving phase. if the value cannot be resolved,
	// an error should be returned.
	ResolveValue(context ResolveContext) (interface{}, error)
}

type ParameterParser func(ParameterParserContext) (Parameter, error)

type ParameterParserContext struct {
	// coordinates of the current config to parse
	Coordinate  coordinate.Coordinate
	Group       string
	Environment string
	// name of the current parameter to parse
	ParameterName string
	// current value to parse
	Value map[string]interface{}
}

type ParameterParserError struct {
	// Location of the config the error happened in
	Location           coordinate.Coordinate     `json:"location"`
	EnvironmentDetails errors.EnvironmentDetails `json:"environmentDetails"`
	// ParameterName holds the name of the parameter triggering the error
	ParameterName string `json:"parameterName"`
	// Reason is a text describing what went wrong
	Reason string `json:"reason"`
}

type ParameterReference struct {
	Config   coordinate.Coordinate
	Property string
}

type ParameterResolveValueError struct {
	Location           coordinate.Coordinate     `json:"location"`
	EnvironmentDetails errors.EnvironmentDetails `json:"environmentDetails"`
	ParameterName      string                    `json:"parameterName"`
	Reason             string                    `json:"reason"`
}

type ParameterSerDe struct {
	Serializer   ParameterWriter
	Deserializer ParameterParser
}

type ParameterWriter func(ParameterWriterContext) (map[string]interface{}, error)

type ParameterWriterContext struct {
	// coordinates of the current config to parse
	Coordinate  coordinate.Coordinate
	Group       string
	Environment string
	// name of the current parameter to parse
	ParameterName string
	// current value to parse
	Parameter Parameter
}

type ParameterWriterError struct {
	// config the error happened in
	Location           coordinate.Coordinate     `json:"location"`
	EnvironmentDetails errors.EnvironmentDetails `json:"environmentDetails"`
	// name of the parameter triggering the error
	ParameterName string `json:"parameterName"`
	// text describing what went wrong
	Reason string `json:"reason"`
}

type Properties map[string]interface{}

type ResolveContext struct {
	// map of already resolved (and deployed) configs
	ResolvedEntities ResolvedEntities

	// coordinates of the current config
	ConfigCoordinate coordinate.Coordinate

	// group of the current config
	Group string

	// environment of the current config
	Environment string

	// name of the parameter to resolve
	ParameterName string

	// resolved values of the current config
	ResolvedParameterValues Properties
}

type ResolvedEntities map[coordinate.Coordinate]ResolvedEntity

type ResolvedEntity struct {
	// EntityName is the name returned by the Dynatrace api. In theory should be the
	// same as the `name` property defined in the configuration, but
	// can differ.
	EntityName string

	// coordinate of the config this entity represents
	Coordinate coordinate.Coordinate

	// Properties defines a map of all already resolved parameters
	Properties Properties

	// Skip flag indicating that this entity was skipped
	// if a entity is skipped, there will be no properties
	Skip bool
}