arguments

Documentation

Index

• func AddAutoscalingFlags(fs *pflag.FlagSet, value *cluster.Autoscaling)
• func AddBodyFlag(fs *pflag.FlagSet, value *string)
• func AddCCSFlags(fs *pflag.FlagSet, value *cluster.CCS)
• func AddCCSFlagsWithoutAccountID(fs *pflag.FlagSet, value *cluster.CCS)
• func AddDebugFlag(fs *pflag.FlagSet)
• func AddHeaderFlag(fs *pflag.FlagSet, values *[]string)
• func AddInteractiveFlag(flags *pflag.FlagSet, value *bool)
• func AddParameterFlag(fs *pflag.FlagSet, values *[]string)
• func AddProviderFlag(fs *pflag.FlagSet, value *string)
• func ApplyBodyFlag(request *sdk.Request, value string) error
• func ApplyHeaderFlag(request interface{}, values []string)
• func ApplyParameterFlag(request interface{}, values []string)
• func ApplyPathArg(request *sdk.Request, value string) error
• func CheckIgnoredAutoscalingFlags(autoscaling cluster.Autoscaling, computeNodes int) error
• func CheckIgnoredCCSFlags(ccs cluster.CCS) error
• func CheckOneOf(fs *pflag.FlagSet, flagName string, options []Option) error
• func PromptBool(fs *pflag.FlagSet, flagName string) error
• func PromptFilePath(fs *pflag.FlagSet, flagName string) error
• func PromptIPNet(fs *pflag.FlagSet, flagName string) error
• func PromptInt(fs *pflag.FlagSet, flagName string, validate func() error) error
• func PromptOneOf(fs *pflag.FlagSet, flagName string, options []Option) error
• func PromptOrCheckOneOf(fs *pflag.FlagSet, flagName string, options []Option) error
• func PromptPassword(fs *pflag.FlagSet, flagName string) error
• func PromptString(fs *pflag.FlagSet, flagName string) error
• func SetQuestion(fs *pflag.FlagSet, flagName, question string)
• func Split(r rune) bool
• type CobraCompletionFunc
  • func MakeCompleteFunc(optionsFunc OptionsFunc) CobraCompletionFunc
• type FilePath
  • func (f *FilePath) Set(v string) error
  • func (f *FilePath) String() string
  • func (f *FilePath) Type() string
• type Option
• type OptionsFunc

Functions

func AddAutoscalingFlags

func AddAutoscalingFlags(fs *pflag.FlagSet, value *cluster.Autoscaling)

AddAutoscalingFlags adds the --enable-autoscaling --min-replicas and --max-replicas flags

func AddBodyFlag

func AddBodyFlag(fs *pflag.FlagSet, value *string)

AddBodyFlag adds the '--body' flag to the given set of command line flags.

func AddCCSFlags

func AddCCSFlags(fs *pflag.FlagSet, value *cluster.CCS)

AddCCSFlags adds all the flags needed for creating a cluster.

func AddCCSFlagsWithoutAccountID

func AddCCSFlagsWithoutAccountID(fs *pflag.FlagSet, value *cluster.CCS)

AddCCSFlagsWithoutAccountID is sufficient for list regions command.

func AddDebugFlag

func AddDebugFlag(fs *pflag.FlagSet)

AddDebugFlag adds the '--debug' flag to the given set of command line flags.

func AddHeaderFlag

func AddHeaderFlag(fs *pflag.FlagSet, values *[]string)

AddHeaderFlag adds the '--header' flag to the given set of command line flags.

func AddInteractiveFlag

func AddInteractiveFlag(flags *pflag.FlagSet, value *bool)

AddFlag adds the interactive flag to the given set of command line flags.

func AddParameterFlag

func AddParameterFlag(fs *pflag.FlagSet, values *[]string)

AddParameterFlag adds the '--parameter' flag to the given set of command line flags.

func AddProviderFlag

func AddProviderFlag(fs *pflag.FlagSet, value *string)

func ApplyBodyFlag

func ApplyBodyFlag(request *sdk.Request, value string) error

ApplyBodyFlag applies the value of the '--body' command line flag to the given request.

func ApplyHeaderFlag

func ApplyHeaderFlag(request interface{}, values []string)

ApplyHeaderFlag applies the value of the '--header' command line flag to the given request.

func ApplyParameterFlag

func ApplyParameterFlag(request interface{}, values []string)

ApplyParameterFlag applies the value of the '--parameter' command line flag to the given request.

func ApplyPathArg

func ApplyPathArg(request *sdk.Request, value string) error

ApplyPathArg applies the value of the path given in the command line to the given request.

func CheckIgnoredAutoscalingFlags

func CheckIgnoredAutoscalingFlags(autoscaling cluster.Autoscaling, computeNodes int) error

CheckIgnoredAutoscalingFlags errors if --min-replicas or --max-replicas were used without --enable-autoscaling (and vice-versa with --compute-nodes)

func CheckIgnoredCCSFlags

func CheckIgnoredCCSFlags(ccs cluster.CCS) error

CheckIgnoredCCSFlags errors if --aws-... were used without --ccs.

func CheckOneOf

func CheckOneOf(fs *pflag.FlagSet, flagName string, options []Option) error

CheckOneOf returns error if flag has been set and is not one of given options. It's appropriate for both optional flags (no error not given) and required flags (Cobra validated they're given before command .Run).

func PromptBool

func PromptBool(fs *pflag.FlagSet, flagName string) error

PromptBool sets a bool flag value interactively, unless already set. Does nothing in non-interactive mode.

func PromptFilePath

func PromptFilePath(fs *pflag.FlagSet, flagName string) error

PromptFilePath sets a FilePath flag value interactively, unless already set. Does nothing in non-interactive mode.

func PromptIPNet

func PromptIPNet(fs *pflag.FlagSet, flagName string) error

PromptIPNet sets an optional IPNet flag value interactively, unless already set. Does nothing in non-interactive mode.

func PromptInt

func PromptInt(fs *pflag.FlagSet, flagName string, validate func() error) error

PromptInt sets an integer flag value interactively, unless already set. validation func is optional, and runs after the flag is already set. Does nothing in non-interactive mode. TODO: always validate, prompt if bad.

func PromptOneOf

func PromptOneOf(fs *pflag.FlagSet, flagName string, options []Option) error

PromptOneOf sets a string flag value interactively, from a set of valid options, unless already set.

func PromptOrCheckOneOf

func PromptOrCheckOneOf(fs *pflag.FlagSet, flagName string, options []Option) error

PromptOrCheckOneOf uses a set of valid options for interactive prompt and/or validation. When flag is already set, validates it and doesn't prompt. TODO: prompt if bad. When not interactive, allows an optional flag to remain omitted.

func PromptPassword

func PromptPassword(fs *pflag.FlagSet, flagName string) error

PromptPassword sets a sensitive string flag value interactively, unless already set. Does nothing in non-interactive mode.

func PromptString

func PromptString(fs *pflag.FlagSet, flagName string) error

PromptString sets a string flag value interactively, unless already set. Does nothing in non-interactive mode.

func SetQuestion

func SetQuestion(fs *pflag.FlagSet, flagName, question string)

SetQuestion sets a friendlier text to use when prompting instead of flag name.

func Split

func Split(r rune) bool

Types

type CobraCompletionFunc

type CobraCompletionFunc func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CobraCompletionFunc is the signature cobra.RegisterFlagCompletionFunc() wants.

func MakeCompleteFunc

func MakeCompleteFunc(optionsFunc OptionsFunc) CobraCompletionFunc

type FilePath

type FilePath string

func (*FilePath) Set

func (f *FilePath) Set(v string) error

func (*FilePath) String

func (f *FilePath) String() string

func (*FilePath) Type

func (f *FilePath) Type() string

type Option

type Option struct {
	Value string
	// Optional extra text to show (not always supported).
	Description string
}

Option represents a value that can be used in interactive Select menu, or shell completion.

type OptionsFunc

type OptionsFunc func(connection *sdk.Connection) ([]Option, error)

OptionsFunc is a signature for functions generating arrays of values. They will be used both for interactive mode and flag completions.