command

package
v1.0.0-alpha3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 2, 2018 License: Apache-2.0 Imports: 44 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	//EnvConfigJSON can be used to pass the config file as a json encoded string
	EnvConfigJSON = "NERD_CONFIG_JSON"

	//EnvNerdProject can be used to set the nerd project
	EnvNerdProject = "NERD_PROJECT"
)
View Source 
const (
	//OutputDirPermissions are the output directory's permissions.
	OutputDirPermissions = 0755
	//DownloadConcurrency is the amount of concurrent download threads.
	DownloadConcurrency = 10
)
View Source 
const (
	//UploadConcurrency is the amount of concurrent upload threads.
	UploadConcurrency = 64
)

Variables

View Source 
var (
	//SharedOptionsGroup are options shared by all commands
	SharedOptionsGroup = "Other Options"
)

Functions

func CreateVersionFactory added in v0.5.6 

func CreateVersionFactory(version, commit string) cli.CommandFactory

CreateVersionFactory returns a factory method for the join command

func DatasetDownloadFactory added in v0.4.12 

func DatasetDownloadFactory() (cli.Command, error)

DatasetDownloadFactory returns a factory method for the join command

func DatasetFactory added in v0.4.12 

func DatasetFactory() (cli.Command, error)

DatasetFactory returns a factory method for the join command

func DatasetListFactory added in v0.4.15 

func DatasetListFactory() (cli.Command, error)

DatasetListFactory returns a factory method for the join command

func DatasetUploadFactory added in v0.4.12 

func DatasetUploadFactory() (cli.Command, error)

DatasetUploadFactory returns a factory method for the join command

func ErrorCauser 

func ErrorCauser(err error) error

ErrorCauser returns the error that is one level up in the error chain.

func HandleError 

func HandleError(err error) error

HandleError handles the way errors are presented to the user.

func LoginFactory 

func LoginFactory() (cli.Command, error)

LoginFactory returns a factory method for the join command

func NewClient 

func NewClient(c *conf.Config, session *conf.Session, outputter *format.Outputter) (*v1batch.Client, error)

NewClient creates a new batch Client.

func ProgressBar added in v0.4.12 

func ProgressBar(w io.Writer, total int64, progressCh <-chan int64, doneCh chan<- struct{})

ProgressBar creates a new CLI progess bar and adds input from the progressCh to the bar.

func ProjectExpelFactory added in v0.4.12 

func ProjectExpelFactory() (cli.Command, error)

ProjectExpelFactory returns a factory method for the join command

func ProjectFactory added in v0.4.12 

func ProjectFactory() (cli.Command, error)

ProjectFactory returns a factory method for the join command

func ProjectListFactory added in v0.4.12 

func ProjectListFactory() (cli.Command, error)

ProjectListFactory returns a factory method for the join command

func ProjectPlaceFactory added in v0.4.12 

func ProjectPlaceFactory() (cli.Command, error)

ProjectPlaceFactory returns a factory method for the join command

func ProjectSetFactory added in v0.4.12 

func ProjectSetFactory() (cli.Command, error)

ProjectSetFactory returns a factory method for the join command

func SecretCreateFactory added in v0.5.6 

func SecretCreateFactory() (cli.Command, error)

SecretCreateFactory returns a factory method for the secret create command

func SecretDeleteFactory added in v0.5.6 

func SecretDeleteFactory() (cli.Command, error)

SecretDeleteFactory returns a factory method for the secret delete command

func SecretDescribeFactory added in v0.5.6 

func SecretDescribeFactory() (cli.Command, error)

SecretDescribeFactory returns a factory method for the secret describe command

func SecretFactory added in v0.5.6 

func SecretFactory() (cli.Command, error)

SecretFactory returns a factory method for the secret command

func SecretListFactory added in v0.5.6 

func SecretListFactory() (cli.Command, error)

SecretListFactory returns a factory method for the secret list command

func TaskCreateFactory added in v0.5.7 

func TaskCreateFactory() (cli.Command, error)

TaskCreateFactory returns a factory method for the join command

func TaskDescribeFactory added in v0.4.12 

func TaskDescribeFactory() (cli.Command, error)

TaskDescribeFactory returns a factory method for the join command

func TaskFactory added in v0.4.12 

func TaskFactory() (cli.Command, error)

TaskFactory returns a factory method for the join command

func TaskFailureFactory added in v0.4.12 

func TaskFailureFactory() (cli.Command, error)

TaskFailureFactory returns a factory method for the join command

func TaskHeartbeatFactory added in v0.4.12 

func TaskHeartbeatFactory() (cli.Command, error)

TaskHeartbeatFactory returns a factory method for the join command

func TaskListFactory added in v0.4.12 

func TaskListFactory() (cli.Command, error)

TaskListFactory returns a factory method for the join command

func TaskReceiveFactory added in v0.4.12 

func TaskReceiveFactory() (cli.Command, error)

TaskReceiveFactory returns a factory method for the join command

func TaskStopFactory added in v0.4.12 

func TaskStopFactory() (cli.Command, error)

TaskStopFactory returns a factory method for the join command

func TaskSuccessFactory added in v0.4.12 

func TaskSuccessFactory() (cli.Command, error)

TaskSuccessFactory returns a factory method for the join command

func UserPassProvider added in v0.1.1 

func UserPassProvider(ui cli.Ui) func() (string, string, error)

UserPassProvider prompts the username and password on stdin.

func WorkerFactory added in v0.4.12 

func WorkerFactory() (cli.Command, error)

WorkerFactory returns a factory method for the join command

func WorkerLogsFactory added in v0.5.1 

func WorkerLogsFactory() (cli.Command, error)

WorkerLogsFactory returns a factory method for the join command

func WorkloadDescribeFactory added in v0.4.15 

func WorkloadDescribeFactory() (cli.Command, error)

WorkloadDescribeFactory returns a factory method for the join command

func WorkloadDownloadFactory added in v0.4.15 

func WorkloadDownloadFactory() (cli.Command, error)

WorkloadDownloadFactory returns a factory method for the join command

func WorkloadFactory added in v0.4.15 

func WorkloadFactory() (cli.Command, error)

WorkloadFactory returns a factory method for the join command

func WorkloadListFactory added in v0.4.15 

func WorkloadListFactory() (cli.Command, error)

WorkloadListFactory returns a factory method for the join command

func WorkloadStartFactory added in v0.4.15 

func WorkloadStartFactory() (cli.Command, error)

WorkloadStartFactory returns a factory method for the join command

func WorkloadStopFactory added in v0.4.15 

func WorkloadStopFactory() (cli.Command, error)

WorkloadStopFactory returns a factory method for the join command

func WorkloadWorkFactory added in v0.4.15 

func WorkloadWorkFactory() (cli.Command, error)

WorkloadWorkFactory returns a factory method for the join command

Types

type Chunker added in v0.4.12 

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

Chunker is a wrapper of the restic/chunker library, to make it compatible with the v1data.Chunker interface.

func NewChunker added in v0.4.12 

func NewChunker(pol uint64, r io.Reader) *Chunker

NewChunker returns a new Chunker

func (*Chunker) Next added in v0.4.12 

func (c *Chunker) Next() (data []byte, length uint, err error)

Next wraps the restic/chunker Next call.

type ConfOpts 

type ConfOpts struct {
	ConfigFile  func(string) `long:"config-file" default:"" default-mask:"" env:"NERD_CONFIG_FILE" description:"Location of config file"`
	SessionFile func(string) `long:"session-file" default:"" default-mask:"" env:"NERD_SESSION_FILE" description:"Location of session file"`
	OutputOpts
}

ConfOpts are the options related to config file and the way output is handled.

type Dataset added in v0.4.12 

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

Dataset command

func (Dataset) Description added in v0.5.1 

func (c Dataset) Description() string

func (*Dataset) DoRun added in v0.4.12 

func (cmd *Dataset) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Dataset) Help added in v0.4.12 

func (c Dataset) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (Dataset) Options added in v0.5.1 

func (c Dataset) Options() *flags.Parser

func (Dataset) Run added in v0.4.12 

func (c Dataset) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Dataset) Synopsis added in v0.4.12 

func (c Dataset) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Dataset) Usage added in v0.5.1 

func (c Dataset) Usage() string

type DatasetList added in v0.4.15 

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

DatasetList command

func (DatasetList) Description added in v0.5.1 

func (c DatasetList) Description() string

func (*DatasetList) DoRun added in v0.4.15 

func (cmd *DatasetList) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (DatasetList) Help added in v0.4.15 

func (c DatasetList) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (DatasetList) Options added in v0.5.1 

func (c DatasetList) Options() *flags.Parser

func (DatasetList) Run added in v0.4.15 

func (c DatasetList) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (DatasetList) Synopsis added in v0.4.15 

func (c DatasetList) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (DatasetList) Usage added in v0.5.1 

func (c DatasetList) Usage() string

type Download 

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

Download command

func (Download) Description added in v0.5.1 

func (c Download) Description() string

func (*Download) DoRun 

func (cmd *Download) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Download) Help 

func (c Download) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (Download) Options added in v0.5.1 

func (c Download) Options() *flags.Parser

func (Download) Run 

func (c Download) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Download) Synopsis 

func (c Download) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Download) Usage added in v0.5.1 

func (c Download) Usage() string

type Login 

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

Login command

func (Login) Description added in v0.5.1 

func (c Login) Description() string

func (*Login) DoRun 

func (cmd *Login) DoRun(args []string) error

DoRun is called by run and allows an error to be returned

func (Login) Help 

func (c Login) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (Login) Options added in v0.5.1 

func (c Login) Options() *flags.Parser

func (Login) Run 

func (c Login) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Login) Synopsis 

func (c Login) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Login) Usage added in v0.5.1 

func (c Login) Usage() string

type LoginOpts 

type LoginOpts struct {
	Config     string `long:"config-src" default:"oidc" default-mask:"" description:"type of configuration to use (from env, endpoint, or oidc)"`
	KubeConfig string `` /* 135-byte string literal not displayed */
}

LoginOpts defines options for login command

type OutputOpts 

type OutputOpts struct {
	Debug  func(bool)   `long:"debug" default:"false" optional:"true" optional-value:"true" description:"Show debug output" env:"NERD_DEBUG"`
	Output func(string) `long:"output" default:"pretty" description:"Format of the output" choice:"pretty" choice:"raw" choice:"json"`
}

OutputOpts are options that are related to CLI output.

type Project added in v0.4.12 

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

Project command

func (Project) Description added in v0.5.1 

func (c Project) Description() string

func (*Project) DoRun added in v0.4.12 

func (cmd *Project) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Project) Help added in v0.4.12 

func (c Project) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (*Project) HelpTemplate added in v0.4.15 

func (cmd *Project) HelpTemplate() string

HelpTemplate provides a template for the help command, which excludes the "expel" and "place" subcommands

func (Project) Options added in v0.5.1 

func (c Project) Options() *flags.Parser

func (Project) Run added in v0.4.12 

func (c Project) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Project) Synopsis added in v0.4.12 

func (c Project) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Project) Usage added in v0.5.1 

func (c Project) Usage() string

type ProjectExpel added in v0.4.12 

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

ProjectExpel command

func (ProjectExpel) Description added in v0.5.1 

func (c ProjectExpel) Description() string

func (*ProjectExpel) DoRun added in v0.4.12 

func (cmd *ProjectExpel) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (ProjectExpel) Help added in v0.4.12 

func (c ProjectExpel) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (ProjectExpel) Options added in v0.5.1 

func (c ProjectExpel) Options() *flags.Parser

func (ProjectExpel) Run added in v0.4.12 

func (c ProjectExpel) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (ProjectExpel) Synopsis added in v0.4.12 

func (c ProjectExpel) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (ProjectExpel) Usage added in v0.5.1 

func (c ProjectExpel) Usage() string

type ProjectList added in v0.4.12 

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

ProjectList command

func (ProjectList) Description added in v0.5.1 

func (c ProjectList) Description() string

func (*ProjectList) DoRun added in v0.4.12 

func (cmd *ProjectList) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (ProjectList) Help added in v0.4.12 

func (c ProjectList) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (ProjectList) Options added in v0.5.1 

func (c ProjectList) Options() *flags.Parser

func (ProjectList) Run added in v0.4.12 

func (c ProjectList) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (ProjectList) Synopsis added in v0.4.12 

func (c ProjectList) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (ProjectList) Usage added in v0.5.1 

func (c ProjectList) Usage() string

type ProjectPlace added in v0.4.12 

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

ProjectPlace command

func (ProjectPlace) Description added in v0.5.1 

func (c ProjectPlace) Description() string

func (*ProjectPlace) DoRun added in v0.4.12 

func (cmd *ProjectPlace) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (ProjectPlace) Help added in v0.4.12 

func (c ProjectPlace) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (ProjectPlace) Options added in v0.5.1 

func (c ProjectPlace) Options() *flags.Parser

func (ProjectPlace) Run added in v0.4.12 

func (c ProjectPlace) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (ProjectPlace) Synopsis added in v0.4.12 

func (c ProjectPlace) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (ProjectPlace) Usage added in v0.5.1 

func (c ProjectPlace) Usage() string

type ProjectPlaceOpts added in v0.4.12 

type ProjectPlaceOpts struct {
	Token        string `long:"token" default:"" default-mask:"" description:"placement that authenticates using JWT"`
	Username     string `long:"username" default:"" default-mask:"" description:"username for placement that authenticates using username/password"`
	Password     string `long:"password" default:"" default-mask:"" description:"password for placement that authenticates using username/password"`
	Insecure     bool   `long:"insecure" default-mask:"" description:"disable checking of server certificate"`
	ComputeUnits string `long:"compute_units" default:"2" description:"default size of a project"`
}

ProjectPlaceOpts describes command options

type ProjectSet added in v0.4.12 

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

ProjectSet command

func (ProjectSet) Description added in v0.5.1 

func (c ProjectSet) Description() string

func (*ProjectSet) DoRun added in v0.4.12 

func (cmd *ProjectSet) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (ProjectSet) Help added in v0.4.12 

func (c ProjectSet) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (ProjectSet) Options added in v0.5.1 

func (c ProjectSet) Options() *flags.Parser

func (ProjectSet) Run added in v0.4.12 

func (c ProjectSet) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (ProjectSet) Synopsis added in v0.4.12 

func (c ProjectSet) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (ProjectSet) Usage added in v0.5.1 

func (c ProjectSet) Usage() string

type ProjectSetOpts 

type ProjectSetOpts struct {
	Config     string `long:"config-src" default:"oidc" default-mask:"" description:"type of configuration to use (from env, endpoint, or oidc)"`
	KubeConfig string `` /* 135-byte string literal not displayed */
}

ProjectSetOpts determine

type Secret added in v0.5.6 

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

Secret command

func (Secret) Description added in v0.5.6 

func (c Secret) Description() string

func (*Secret) DoRun added in v0.5.6 

func (cmd *Secret) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Secret) Help added in v0.5.6 

func (c Secret) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (Secret) Options added in v0.5.6 

func (c Secret) Options() *flags.Parser

func (Secret) Run added in v0.5.6 

func (c Secret) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Secret) Synopsis added in v0.5.6 

func (c Secret) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Secret) Usage added in v0.5.6 

func (c Secret) Usage() string

type SecretCreate added in v0.5.6 

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

SecretCreate command

func (SecretCreate) Description added in v0.5.6 

func (c SecretCreate) Description() string

func (*SecretCreate) DoRun added in v0.5.6 

func (cmd *SecretCreate) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (SecretCreate) Help added in v0.5.6 

func (c SecretCreate) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (SecretCreate) Options added in v0.5.6 

func (c SecretCreate) Options() *flags.Parser

func (SecretCreate) Run added in v0.5.6 

func (c SecretCreate) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (SecretCreate) Synopsis added in v0.5.6 

func (c SecretCreate) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (SecretCreate) Usage added in v0.5.6 

func (c SecretCreate) Usage() string

type SecretCreateOpts added in v0.5.6 

type SecretCreateOpts struct {
	Username string `long:"username" default:"" default-mask:"" description:"Username for Docker registry authentication"`
	Password string `long:"password" default:"" default-mask:"" description:"Password for Docker registry authentication"`
	Type     string `long:"type" default:"opaque" default-mask:"" description:"Type of secret to display"`
}

SecretCreateOpts describes the options to the SecretCreate command

type SecretDelete added in v0.5.6 

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

SecretDelete command

func (SecretDelete) Description added in v0.5.6 

func (c SecretDelete) Description() string

func (*SecretDelete) DoRun added in v0.5.6 

func (cmd *SecretDelete) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (SecretDelete) Help added in v0.5.6 

func (c SecretDelete) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (SecretDelete) Options added in v0.5.6 

func (c SecretDelete) Options() *flags.Parser

func (SecretDelete) Run added in v0.5.6 

func (c SecretDelete) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (SecretDelete) Synopsis added in v0.5.6 

func (c SecretDelete) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (SecretDelete) Usage added in v0.5.6 

func (c SecretDelete) Usage() string

type SecretDescribe added in v0.5.6 

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

SecretDescribe command

func (SecretDescribe) Description added in v0.5.6 

func (c SecretDescribe) Description() string

func (*SecretDescribe) DoRun added in v0.5.6 

func (cmd *SecretDescribe) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (SecretDescribe) Help added in v0.5.6 

func (c SecretDescribe) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (SecretDescribe) Options added in v0.5.6 

func (c SecretDescribe) Options() *flags.Parser

func (SecretDescribe) Run added in v0.5.6 

func (c SecretDescribe) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (SecretDescribe) Synopsis added in v0.5.6 

func (c SecretDescribe) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (SecretDescribe) Usage added in v0.5.6 

func (c SecretDescribe) Usage() string

type SecretList added in v0.5.6 

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

SecretList command

func (SecretList) Description added in v0.5.6 

func (c SecretList) Description() string

func (*SecretList) DoRun added in v0.5.6 

func (cmd *SecretList) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (SecretList) Help added in v0.5.6 

func (c SecretList) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (SecretList) Options added in v0.5.6 

func (c SecretList) Options() *flags.Parser

func (SecretList) Run added in v0.5.6 

func (c SecretList) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (SecretList) Synopsis added in v0.5.6 

func (c SecretList) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (SecretList) Usage added in v0.5.6 

func (c SecretList) Usage() string

type SecretListOpts added in v0.5.6 

type SecretListOpts struct {
	Type string `long:"type" default:"all" default-mask:"" description:"Type of secret to display, defaults to all."`
}

SecretListOpts describes the options to the SecretList command

type Task added in v0.4.12 

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

Task command

func (Task) Description added in v0.5.1 

func (c Task) Description() string

func (*Task) DoRun added in v0.4.12 

func (cmd *Task) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Task) Help added in v0.4.12 

func (c Task) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (*Task) HelpTemplate added in v0.4.15 

func (cmd *Task) HelpTemplate() string

HelpTemplate provides a template for the help command, which excludes the "failure", "heartbeat", "receive", and "success" subcommands

func (Task) Options added in v0.5.1 

func (c Task) Options() *flags.Parser

func (Task) Run added in v0.4.12 

func (c Task) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Task) Synopsis added in v0.4.12 

func (c Task) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Task) Usage added in v0.5.1 

func (c Task) Usage() string

type TaskCreate added in v0.5.7 

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

TaskCreate command

func (TaskCreate) Description added in v0.5.7 

func (c TaskCreate) Description() string

func (*TaskCreate) DoRun added in v0.5.7 

func (cmd *TaskCreate) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskCreate) Help added in v0.5.7 

func (c TaskCreate) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskCreate) Options added in v0.5.7 

func (c TaskCreate) Options() *flags.Parser

func (TaskCreate) Run added in v0.5.7 

func (c TaskCreate) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskCreate) Synopsis added in v0.5.7 

func (c TaskCreate) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskCreate) Usage added in v0.5.7 

func (c TaskCreate) Usage() string

type TaskCreateOpts added in v0.5.7 

type TaskCreateOpts struct {
	Env []string `long:"env" short:"e" description:"environment variables to use"`
}

TaskCreateOpts describes command options

type TaskDescribe added in v0.4.12 

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

TaskDescribe command

func (TaskDescribe) Description added in v0.5.1 

func (c TaskDescribe) Description() string

func (*TaskDescribe) DoRun added in v0.4.12 

func (cmd *TaskDescribe) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskDescribe) Help added in v0.4.12 

func (c TaskDescribe) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskDescribe) Options added in v0.5.1 

func (c TaskDescribe) Options() *flags.Parser

func (TaskDescribe) Run added in v0.4.12 

func (c TaskDescribe) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskDescribe) Synopsis added in v0.4.12 

func (c TaskDescribe) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskDescribe) Usage added in v0.5.1 

func (c TaskDescribe) Usage() string

type TaskFailure added in v0.4.12 

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

TaskFailure command

func (TaskFailure) Description added in v0.5.1 

func (c TaskFailure) Description() string

func (*TaskFailure) DoRun added in v0.4.12 

func (cmd *TaskFailure) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskFailure) Help added in v0.4.12 

func (c TaskFailure) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskFailure) Options added in v0.5.1 

func (c TaskFailure) Options() *flags.Parser

func (TaskFailure) Run added in v0.4.12 

func (c TaskFailure) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskFailure) Synopsis added in v0.4.12 

func (c TaskFailure) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskFailure) Usage added in v0.5.1 

func (c TaskFailure) Usage() string

type TaskHeartbeat added in v0.4.12 

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

TaskHeartbeat command

func (TaskHeartbeat) Description added in v0.5.1 

func (c TaskHeartbeat) Description() string

func (*TaskHeartbeat) DoRun added in v0.4.12 

func (cmd *TaskHeartbeat) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskHeartbeat) Help added in v0.4.12 

func (c TaskHeartbeat) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskHeartbeat) Options added in v0.5.1 

func (c TaskHeartbeat) Options() *flags.Parser

func (TaskHeartbeat) Run added in v0.4.12 

func (c TaskHeartbeat) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskHeartbeat) Synopsis added in v0.4.12 

func (c TaskHeartbeat) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskHeartbeat) Usage added in v0.5.1 

func (c TaskHeartbeat) Usage() string

type TaskList added in v0.4.12 

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

TaskList command

func (TaskList) Description added in v0.5.1 

func (c TaskList) Description() string

func (*TaskList) DoRun added in v0.4.12 

func (cmd *TaskList) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskList) Help added in v0.4.12 

func (c TaskList) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskList) Options added in v0.5.1 

func (c TaskList) Options() *flags.Parser

func (TaskList) Run added in v0.4.12 

func (c TaskList) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskList) Synopsis added in v0.4.12 

func (c TaskList) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskList) Usage added in v0.5.1 

func (c TaskList) Usage() string

type TaskReceive added in v0.4.12 

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

TaskReceive command

func (TaskReceive) Description added in v0.5.1 

func (c TaskReceive) Description() string

func (*TaskReceive) DoRun added in v0.4.12 

func (cmd *TaskReceive) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskReceive) Help added in v0.4.12 

func (c TaskReceive) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskReceive) Options added in v0.5.1 

func (c TaskReceive) Options() *flags.Parser

func (TaskReceive) Run added in v0.4.12 

func (c TaskReceive) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskReceive) Synopsis added in v0.4.12 

func (c TaskReceive) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskReceive) Usage added in v0.5.1 

func (c TaskReceive) Usage() string

type TaskStop added in v0.4.12 

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

TaskStop command

func (TaskStop) Description added in v0.5.1 

func (c TaskStop) Description() string

func (*TaskStop) DoRun added in v0.4.12 

func (cmd *TaskStop) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskStop) Help added in v0.4.12 

func (c TaskStop) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskStop) Options added in v0.5.1 

func (c TaskStop) Options() *flags.Parser

func (TaskStop) Run added in v0.4.12 

func (c TaskStop) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskStop) Synopsis added in v0.4.12 

func (c TaskStop) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskStop) Usage added in v0.5.1 

func (c TaskStop) Usage() string

type TaskSuccess added in v0.4.12 

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

TaskSuccess command

func (TaskSuccess) Description added in v0.5.1 

func (c TaskSuccess) Description() string

func (*TaskSuccess) DoRun added in v0.4.12 

func (cmd *TaskSuccess) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (TaskSuccess) Help added in v0.4.12 

func (c TaskSuccess) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (TaskSuccess) Options added in v0.5.1 

func (c TaskSuccess) Options() *flags.Parser

func (TaskSuccess) Run added in v0.4.12 

func (c TaskSuccess) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (TaskSuccess) Synopsis added in v0.4.12 

func (c TaskSuccess) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (TaskSuccess) Usage added in v0.5.1 

func (c TaskSuccess) Usage() string

type Upload 

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

Upload command

func (Upload) Description added in v0.5.1 

func (c Upload) Description() string

func (*Upload) DoRun 

func (cmd *Upload) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Upload) Help 

func (c Upload) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (Upload) Options added in v0.5.1 

func (c Upload) Options() *flags.Parser

func (Upload) Run 

func (c Upload) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Upload) Synopsis 

func (c Upload) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Upload) Usage added in v0.5.1 

func (c Upload) Usage() string

type Version added in v0.5.6 

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

Version command

func (Version) Description added in v0.5.6 

func (c Version) Description() string

func (Version) Help added in v0.5.6 

func (c Version) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (Version) Options added in v0.5.6 

func (c Version) Options() *flags.Parser

func (*Version) Run added in v0.5.6 

func (cmd *Version) Run(args []string) int

Run is called by run and allows an error to be returned

func (Version) Synopsis added in v0.5.6 

func (c Version) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Version) Usage added in v0.5.6 

func (c Version) Usage() string

type Worker added in v0.4.12 

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

Worker command

func (Worker) Description added in v0.5.1 

func (c Worker) Description() string

func (*Worker) DoRun added in v0.4.12 

func (cmd *Worker) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Worker) Help added in v0.4.12 

func (c Worker) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (Worker) Options added in v0.5.1 

func (c Worker) Options() *flags.Parser

func (Worker) Run added in v0.4.12 

func (c Worker) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Worker) Synopsis added in v0.4.12 

func (c Worker) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Worker) Usage added in v0.5.1 

func (c Worker) Usage() string

type WorkerLogs added in v0.5.1 

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

WorkerLogs command

func (WorkerLogs) Description added in v0.5.1 

func (c WorkerLogs) Description() string

func (*WorkerLogs) DoRun added in v0.5.1 

func (cmd *WorkerLogs) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (WorkerLogs) Help added in v0.5.1 

func (c WorkerLogs) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (WorkerLogs) Options added in v0.5.1 

func (c WorkerLogs) Options() *flags.Parser

func (WorkerLogs) Run added in v0.5.1 

func (c WorkerLogs) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (WorkerLogs) Synopsis added in v0.5.1 

func (c WorkerLogs) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (WorkerLogs) Usage added in v0.5.1 

func (c WorkerLogs) Usage() string

type Workload added in v0.4.15 

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

Workload command

func (Workload) Description added in v0.5.1 

func (c Workload) Description() string

func (*Workload) DoRun added in v0.4.15 

func (cmd *Workload) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (Workload) Help added in v0.4.15 

func (c Workload) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (*Workload) HelpTemplate added in v0.4.15 

func (cmd *Workload) HelpTemplate() string

HelpTemplate provides a template for the help command, which excludes the "workload work" command

func (Workload) Options added in v0.5.1 

func (c Workload) Options() *flags.Parser

func (Workload) Run added in v0.4.15 

func (c Workload) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (Workload) Synopsis added in v0.4.15 

func (c Workload) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (Workload) Usage added in v0.5.1 

func (c Workload) Usage() string

type WorkloadDescribe added in v0.4.15 

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

WorkloadDescribe command

func (WorkloadDescribe) Description added in v0.5.1 

func (c WorkloadDescribe) Description() string

func (*WorkloadDescribe) DoRun added in v0.4.15 

func (cmd *WorkloadDescribe) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (WorkloadDescribe) Help added in v0.4.15 

func (c WorkloadDescribe) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (WorkloadDescribe) Options added in v0.5.1 

func (c WorkloadDescribe) Options() *flags.Parser

func (WorkloadDescribe) Run added in v0.4.15 

func (c WorkloadDescribe) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (WorkloadDescribe) Synopsis added in v0.4.15 

func (c WorkloadDescribe) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (WorkloadDescribe) Usage added in v0.5.1 

func (c WorkloadDescribe) Usage() string

type WorkloadDownload added in v0.4.15 

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

WorkloadDownload command

func (WorkloadDownload) Description added in v0.5.1 

func (c WorkloadDownload) Description() string

func (*WorkloadDownload) DoRun added in v0.4.15 

func (cmd *WorkloadDownload) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (WorkloadDownload) Help added in v0.4.15 

func (c WorkloadDownload) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (WorkloadDownload) Options added in v0.5.1 

func (c WorkloadDownload) Options() *flags.Parser

func (WorkloadDownload) Run added in v0.4.15 

func (c WorkloadDownload) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (WorkloadDownload) Synopsis added in v0.4.15 

func (c WorkloadDownload) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (WorkloadDownload) Usage added in v0.5.1 

func (c WorkloadDownload) Usage() string

type WorkloadList added in v0.4.15 

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

WorkloadList command

func (WorkloadList) Description added in v0.5.1 

func (c WorkloadList) Description() string

func (*WorkloadList) DoRun added in v0.4.15 

func (cmd *WorkloadList) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (WorkloadList) Help added in v0.4.15 

func (c WorkloadList) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (WorkloadList) Options added in v0.5.1 

func (c WorkloadList) Options() *flags.Parser

func (WorkloadList) Run added in v0.4.15 

func (c WorkloadList) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (WorkloadList) Synopsis added in v0.4.15 

func (c WorkloadList) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (WorkloadList) Usage added in v0.5.1 

func (c WorkloadList) Usage() string

type WorkloadStart added in v0.4.15 

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

WorkloadStart command

func (WorkloadStart) Description added in v0.5.1 

func (c WorkloadStart) Description() string

func (*WorkloadStart) DoRun added in v0.4.15 

func (cmd *WorkloadStart) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (WorkloadStart) Help added in v0.4.15 

func (c WorkloadStart) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (WorkloadStart) Options added in v0.5.1 

func (c WorkloadStart) Options() *flags.Parser

func (WorkloadStart) Run added in v0.4.15 

func (c WorkloadStart) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (WorkloadStart) Synopsis added in v0.4.15 

func (c WorkloadStart) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (WorkloadStart) Usage added in v0.5.1 

func (c WorkloadStart) Usage() string

type WorkloadStartOpts added in v0.4.15 

type WorkloadStartOpts struct {
	Env          []string `long:"env" short:"e" description:"Environment variables"`
	InputDataset string   `long:"input-dataset" short:"d" description:"Input dataset ID, will be available in /input in your container"`
	Instances    int      `long:"instances" short:"i" default:"1" description:"Number of working instances"`
	PullSecret   string   `long:"pull-secret" short:"p" description:"The pull secret will be used to fetch the private image"`
	Size         uint64   `long:"size" short:"s" description:"The amount of resources you want to use for your workload, in compute units."`
}

WorkloadStartOpts describes command options

type WorkloadStop added in v0.4.15 

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

WorkloadStop command

func (WorkloadStop) Description added in v0.5.1 

func (c WorkloadStop) Description() string

func (*WorkloadStop) DoRun added in v0.4.15 

func (cmd *WorkloadStop) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (WorkloadStop) Help added in v0.4.15 

func (c WorkloadStop) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (WorkloadStop) Options added in v0.5.1 

func (c WorkloadStop) Options() *flags.Parser

func (WorkloadStop) Run added in v0.4.15 

func (c WorkloadStop) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (WorkloadStop) Synopsis added in v0.4.15 

func (c WorkloadStop) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (WorkloadStop) Usage added in v0.5.1 

func (c WorkloadStop) Usage() string

type WorkloadWork added in v0.4.15 

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

WorkloadWork command

func (WorkloadWork) Description added in v0.5.1 

func (c WorkloadWork) Description() string

func (*WorkloadWork) DoRun added in v0.4.15 

func (cmd *WorkloadWork) DoRun(args []string) (err error)

DoRun is called by run and allows an error to be returned

func (WorkloadWork) Help added in v0.4.15 

func (c WorkloadWork) Help() string

Will write help text for when a user uses --help, it automatically renders all option groups of the flags.Parser (augmented with default values). It will show an extended help message if it is not empty, else it shows the synopsis.

func (WorkloadWork) Options added in v0.5.1 

func (c WorkloadWork) Options() *flags.Parser

func (WorkloadWork) Run added in v0.4.15 

func (c WorkloadWork) Run(args []string) int

Run wraps a signature that allows returning an error type and parses the arguments for the flags package. If flag parsing fails it sets the exit code to 127, if the command implementation returns a non-nil error the exit code is 1

func (WorkloadWork) Synopsis added in v0.4.15 

func (c WorkloadWork) Synopsis() string

Short explanation of the command as passed in the struction initialization

func (WorkloadWork) Usage added in v0.5.1 

func (c WorkloadWork) Usage() string

type WorkloadWorkOpts added in v0.4.15 

type WorkloadWorkOpts struct {
	EntrypointJSONB64 string `long:"entrypoint-json-base64" default:"W10=" description:"Work entrypoint, first json and then base64 encoded."`
	CmdJSONB64        string `long:"cmd-json-base64" default:"W10=" description:"Work cmd, first json and then base64 encoded."`
	OutputDir         string `` /* 127-byte string literal not displayed */
}

WorkloadWorkOpts describes command options

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.