statemanager

Documentation

Index

• type ComponentAction
• type Manager
  • func NewManager(stateConfig configmanager.State) (Manager, error)
• type ResourceState
  • func (rs *ResourceState) SetOutputs(outputs map[string]interface{})
• type State
• type StateKey
  • func GenerateStateKeyByToolNameAndPluginKind(toolName string, instanceID string) StateKey
  • func StateKeyGenerateFunc(t *configmanager.Tool) StateKey
• type StatesMap
  • func NewStatesMap() StatesMap
  • func (s StatesMap) DeepCopy() StatesMap
  • func (s StatesMap) Format() []byte
  • func (s StatesMap) ToList() []State

Types

type ComponentAction

type ComponentAction string

const (
	ActionCreate ComponentAction = "Create"
	ActionUpdate ComponentAction = "Update"
	ActionDelete ComponentAction = "Delete"
)

type Manager

type Manager interface {
	backend.Backend

	GetStatesMap() StatesMap

	GetState(key StateKey) *State
	AddState(key StateKey, state State) error
	UpdateState(key StateKey, state State) error
	DeleteState(key StateKey) error
	GetOutputs(key StateKey) (interface{}, error)
}

Manager knows how to manage the StatesMap.

func NewManager

func NewManager(stateConfig configmanager.State) (Manager, error)

NewManager returns a new Manager and reads states through backend defined in config.

type ResourceState

type ResourceState map[string]interface{}

func (*ResourceState) SetOutputs

func (rs *ResourceState) SetOutputs(outputs map[string]interface{})

type State

type State struct {
	Name       string
	InstanceID string
	DependsOn  []string
	Options    map[string]interface{}
	Resource   map[string]interface{}
}

State is the single component's state.

type StateKey

type StateKey string

Note: Please use the StateKeyGenerateFunc function to generate StateKey instance.

func GenerateStateKeyByToolNameAndPluginKind

func GenerateStateKeyByToolNameAndPluginKind(toolName string, instanceID string) StateKey

func StateKeyGenerateFunc

func StateKeyGenerateFunc(t *configmanager.Tool) StateKey

type StatesMap

type StatesMap struct {
	*concurrentmap.ConcurrentMap
}

func NewStatesMap

func NewStatesMap() StatesMap

func (StatesMap) DeepCopy

func (s StatesMap) DeepCopy() StatesMap

func (StatesMap) Format

func (s StatesMap) Format() []byte

func (StatesMap) ToList

func (s StatesMap) ToList() []State