The highest tagged major version is
Documentation
¶
Index ¶
- func BoolFromString(b string) (*upcloud.Boolean, error)
- func CustomBashCompletionFunc(name string) string
- func DatabaseStateColour(state upcloud.ManagedDatabaseState) text.Colors
- func HandleError(logline *ui.LogEntry, msg string, err error) (output.Output, error)
- func LoadBalancerOperationalStateColour(state upcloud.LoadBalancerOperationalState) text.Colors
- func Parse(in string) ([]string, error)
- func SearchResources(ids []string, searchFn func(id string) (interface{}, error), ...) ([]string, error)
- func ServerStateColour(state string) text.Colors
- func StorageStateColour(state string) text.Colors
- func ToArray(in interface{}) []interface{}
- type BaseCommand
- type CobraCommand
- type Command
- type Executor
- type MultipleArgumentCommand
- type NoArgumentCommand
- type OfflineCommand
- type SingleArgumentCommand
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BoolFromString ¶
BoolFromString parses a string and returns *upcloud.Boolean
func CustomBashCompletionFunc ¶
CustomBashCompletionFunc returns a bash completion function used by cobras bash completion generator
func DatabaseStateColour ¶ added in v1.4.0
func DatabaseStateColour(state upcloud.ManagedDatabaseState) text.Colors
DatabaseStateColour maps database states to colours
func HandleError ¶ added in v1.3.0
HandleError logs error in livelog by setting message to msg and details to err. Returns (nil, err), where err is the err passed in as input.
func LoadBalancerOperationalStateColour ¶ added in v1.4.0
func LoadBalancerOperationalStateColour(state upcloud.LoadBalancerOperationalState) text.Colors
LoadBalancerOperationalStateColour maps load balancer states to colours
func Parse ¶
Parse parses a complex, querystring-type argument from in and returns all the parts found eg. `--foo bar=baz,flop=flip` returns `[]string{"bar","baz","flop","flip"}`
func SearchResources ¶
func SearchResources( ids []string, searchFn func(id string) (interface{}, error), getUUID func(interface{}) string, ) ([]string, error)
SearchResources is a convenience method to map a list of resources to uuids. Any input strings that are uuids are returned as such and any other string is passed on to searchFn, the results of which are passed on to getUUID which is expected to return a uuid.
func ServerStateColour ¶
ServerStateColour is a helper mapping server states to colours
func StorageStateColour ¶ added in v1.1.0
StorageStateColour is a helper mapping storage states to colours
Types ¶
type BaseCommand ¶
type BaseCommand struct {
// contains filtered or unexported fields
}
BaseCommand is the base type for all commands, implementing Command
func New ¶
func New(name, usage string, examples ...string) *BaseCommand
New returns a BaseCommand that implements Command. It is used as a base to create custom commands from.
func (*BaseCommand) AddFlags ¶
func (s *BaseCommand) AddFlags(flags *pflag.FlagSet)
AddFlags adds a flagset to the command and binds config value into it with namespace
func (*BaseCommand) Cobra ¶
func (s *BaseCommand) Cobra() *cobra.Command
Cobra returns the underlying *cobra.Command
func (*BaseCommand) InitCommand ¶
func (s *BaseCommand) InitCommand()
InitCommand can be overridden to handle flag registration. A hook to handle flag registration. The config values are not available during this hook. Register a cobra hook to use them. You can set defaults though.
func (*BaseCommand) MaximumExecutions ¶
func (s *BaseCommand) MaximumExecutions() int
MaximumExecutions return the max executed workers
type CobraCommand ¶
CobraCommand is an interface for commands that can refer back to their base cobra.Command
type Command ¶
type Command interface {
InitCommand()
CobraCommand
}
Command is the base command type for all commands.
type Executor ¶
type Executor interface {
NewLogEntry(s string) *ui.LogEntry
Update()
Close()
WaitFor(waitFn func() error, timeout time.Duration) error
Server() service.Server
Storage() service.Storage
Network() service.Network
Firewall() service.Firewall
IPAddress() service.IpAddress
Account() service.Account
Plan() service.Plans
All() internal.AllServices
Debug(msg string, args ...interface{})
WithLogger(args ...interface{}) Executor
}
Executor represents the execution context for commands
func NewExecutor ¶
NewExecutor creates the default Executor
type MultipleArgumentCommand ¶
type MultipleArgumentCommand interface {
Command
MaximumExecutions() int
Execute(exec Executor, arg string) (output.Output, error)
}
MultipleArgumentCommand is a command that can accept multiple positional arguments, each of which will result in a (parallel) call to Execute() with the argument.
type NoArgumentCommand ¶
type NoArgumentCommand interface {
Command
ExecuteWithoutArguments(exec Executor) (output.Output, error)
}
NoArgumentCommand is a command that does not care about the positional arguments.
type OfflineCommand ¶ added in v1.2.0
type OfflineCommand interface {
DoesNotUseServices()
}
OfflineCommand is a command that does not need connect to the API, e.g. upctl version.
Source Files
Directories