state

Documentation

Index

• type State
  • func NewState(factory database.TxnRunnerFactory) *State
  • func (m *State) CheckMachineExists(ctx context.Context, name machine.Name) error
  • func (m *State) CheckUnitExists(ctx context.Context, name string) error
  • func (st *State) GetTargetAgentVersion(ctx context.Context) (version.Number, error)

Types

type State

type State struct {
	*domain.StateBase
}

func NewState

func NewState(factory database.TxnRunnerFactory) *State

NewState returns a new State object.

func (*State) CheckMachineExists

func (m *State) CheckMachineExists(
	ctx context.Context,
	name machine.Name,
) error

CheckMachineExists check to see if the given machine exists in the model. If the machine does not exist an error satisfying machineerrors.MachineNotFound is returned.

func (*State) CheckUnitExists

func (m *State) CheckUnitExists(
	ctx context.Context,
	name string,
) error

CheckUnitExists checks to see if the given unit exists in the model. If the unit does not exist an error satisfying applicationerrors.UnitNotFound is returned.

func (*State) GetTargetAgentVersion

func (st *State) GetTargetAgentVersion(ctx context.Context) (version.Number, error)

GetTargetAgentVersion returns the agent version for the model. If the agent_version table has no data, modelerrors.AgentVersionNotFound is returned.