action

Documentation

Index

• Variables
• type Action
  • func NewAction(environment sdk.EnvironmentItem) *Action
  • func (action *Action) GetRemoteDev(resource sdk.ComponentResourceItem) (*remote.RemoteDevelopment, error)
• type Down
  • func NewDown(environment sdk.EnvironmentItem) *Down
  • func (down *Down) Run(parameters *DownParameters) error
• type DownParameters
• type Up
  • func NewUp(environment sdk.EnvironmentItem) *Up
  • func (up *Up) Run(parameters *UpParameters) error
  • func (up *Up) StartSSHTerminal() error
  • func (up *Up) Wait() error
• type UpOptions
• type UpParameters
  • func (params *UpParameters) FillFromOptions() error

Variables

var (
	ErrOneSyncPathSupported = errors.New("only one sync path is supported")

	ErrRemoteDevNotInitialized = errors.New("call Up.Run() successfully before calling other methods")
)

var ErrResourceKindNotSupported = errors.New("resource kind not supported")

Types

type Action

type Action struct {
	// contains filtered or unexported fields
}

func NewAction

func NewAction(
	environment sdk.EnvironmentItem,
) *Action

func (*Action) GetRemoteDev

func (action *Action) GetRemoteDev(resource sdk.ComponentResourceItem) (*remote.RemoteDevelopment, error)

type Down

type Down struct {
	Action
}

func NewDown

func NewDown(
	environment sdk.EnvironmentItem,
) *Down

func (*Down) Run

func (down *Down) Run(parameters *DownParameters) error

type DownParameters

type DownParameters struct {
	Resource sdk.ComponentResourceItem
}

type Up

type Up struct {
	Action
	// contains filtered or unexported fields
}

func NewUp

func NewUp(
	environment sdk.EnvironmentItem,
) *Up

func (*Up) Run

func (up *Up) Run(parameters *UpParameters) error

func (*Up) StartSSHTerminal

func (up *Up) StartSSHTerminal() error

func (*Up) Wait

func (up *Up) Wait() error

type UpOptions

type UpOptions struct {
	ContainerName string

	Profile *sdk.ProfileItem

	EnvironPairs []string

	WaitTimeout int64
}

type UpParameters

type UpParameters struct {
	Resource sdk.ComponentResourceItem

	SyncMode mutagenConfig.Mode

	ManualSelectSingleResource bool

	LocalSyncPath  string
	RemoteSyncPath string

	PortMappings []string

	Options *UpOptions
}

func (*UpParameters) FillFromOptions

func (params *UpParameters) FillFromOptions() error