cmd

Documentation

Overview

Package cmd provides default implementation for command-line-like actions.

Index

• type ResyncAction
  • func (c *ResyncAction) GetDescription(lang ...string) actions.ActionDescription
  • func (c *ResyncAction) GetName() string
  • func (c *ResyncAction) GetParametersForm() *forms.Form
  • func (c *ResyncAction) Init(job *jobs.Job, action *jobs.Action) error
  • func (c *ResyncAction) Run(ctx context.Context, channels *actions.RunnableChannels, ...) (jobs.ActionMessage, error)
  • func (c *ResyncAction) SetTask(task *jobs.Task)
• type RpcAction
  • func (c *RpcAction) GetDescription(lang ...string) actions.ActionDescription
  • func (c *RpcAction) GetName() string
  • func (c *RpcAction) GetParametersForm() *forms.Form
  • func (c *RpcAction) Init(job *jobs.Job, action *jobs.Action) error
  • func (c *RpcAction) Run(ctx context.Context, channels *actions.RunnableChannels, ...) (jobs.ActionMessage, error)
• type WGetAction
  • func (w *WGetAction) GetDescription(lang ...string) actions.ActionDescription
  • func (w *WGetAction) GetName() string
  • func (w *WGetAction) GetParametersForm() *forms.Form
  • func (w *WGetAction) Init(job *jobs.Job, action *jobs.Action) error
  • func (w *WGetAction) Run(ctx context.Context, channels *actions.RunnableChannels, ...) (jobs.ActionMessage, error)

Types

type ResyncAction

type ResyncAction struct {
	common.RuntimeHolder
	ServiceName string
	Path        string
	DryRun      bool
	CrtTask     *jobs.Task
}

func (*ResyncAction) GetDescription

func (c *ResyncAction) GetDescription(lang ...string) actions.ActionDescription

GetDescription returns action description

func (*ResyncAction) GetName

func (c *ResyncAction) GetName() string

GetName provides unique identifier

func (*ResyncAction) GetParametersForm

func (c *ResyncAction) GetParametersForm() *forms.Form

GetParametersForm returns a UX form

func (*ResyncAction) Init

func (c *ResyncAction) Init(job *jobs.Job, action *jobs.Action) error

Init passes parameters

func (*ResyncAction) Run

func (c *ResyncAction) Run(ctx context.Context, channels *actions.RunnableChannels, input jobs.ActionMessage) (jobs.ActionMessage, error)

Run perform actual action code

func (*ResyncAction) SetTask

func (c *ResyncAction) SetTask(task *jobs.Task)

SetTask implements TaskUpdaterDelegateAction as the target service will update the task status on its side.

type RpcAction

type RpcAction struct {
	common.RuntimeHolder
	ServiceName string
	MethodName  string
	JsonRequest string
	Timeout     string
}

func (*RpcAction) GetDescription

func (c *RpcAction) GetDescription(lang ...string) actions.ActionDescription

GetDescription returns action description

func (*RpcAction) GetName

func (c *RpcAction) GetName() string

GetName provides unique identifier

func (*RpcAction) GetParametersForm

func (c *RpcAction) GetParametersForm() *forms.Form

GetParametersForm returns a UX form

func (*RpcAction) Init

func (c *RpcAction) Init(job *jobs.Job, action *jobs.Action) error

Init passes parameters

func (*RpcAction) Run

func (c *RpcAction) Run(ctx context.Context, channels *actions.RunnableChannels, input jobs.ActionMessage) (jobs.ActionMessage, error)

Run perform actual action code

type WGetAction

type WGetAction struct {
	common.RuntimeHolder
	Router    nodes.Client
	SourceUrl string
	// contains filtered or unexported fields
}

WGetAction performs a wget command with the provided URL

func (*WGetAction) GetDescription

func (w *WGetAction) GetDescription(lang ...string) actions.ActionDescription

GetDescription returns action description

func (*WGetAction) GetName

func (w *WGetAction) GetName() string

GetName returns the unique identifier of this action

func (*WGetAction) GetParametersForm

func (w *WGetAction) GetParametersForm() *forms.Form

GetParametersForm returns a UX form

func (*WGetAction) Init

func (w *WGetAction) Init(job *jobs.Job, action *jobs.Action) error

Init passes parameters

func (*WGetAction) Run

func (w *WGetAction) Run(ctx context.Context, channels *actions.RunnableChannels, input jobs.ActionMessage) (jobs.ActionMessage, error)

Run the actual action code