options

Documentation

Index

• func AddPreRunE(c *cobra.Command, f func(*cobra.Command, []string) error)
• func GetClientOptionsGroupHelpCommand() *cobra.Command
• func GetPrintOptionsGroupHelpCommand() *cobra.Command
• type ClientOpts
  • func (opts *ClientOpts) ConfigureDefaultOrganization() error
  • func (opts *ClientOpts) GetAPIClient() (*api.Client, error)
  • func (opts *ClientOpts) GetClientOptionsGroup() *HiddenOptionsGroup
  • func (opts *ClientOpts) GetUnauthenticatedAPIClient() *api.Client
  • func (opts *ClientOpts) IsAuthenticated() bool
  • func (opts *ClientOpts) MustGetAPIClient() *api.Client
  • func (opts *ClientOpts) Register(cmd *cobra.Command)
  • func (opts *ClientOpts) RequireAuthentication() error
  • func (opts *ClientOpts) SetContextValues(context map[string]string)
  • func (opts *ClientOpts) ValidateOrganization() error
• type HiddenOptionsGroup
  • func (group *HiddenOptionsGroup) GetHelpCommand() *cobra.Command
  • func (group *HiddenOptionsGroup) Register(cmd *cobra.Command)
• type Interface
• type PrintClientOpts
  • func (opts *PrintClientOpts) Register(cmd *cobra.Command)
  • func (opts *PrintClientOpts) SetContextValues(context map[string]string)
• type PrintOpts
  • func (p *PrintOpts) GetPrintOptionsGroup() *HiddenOptionsGroup
  • func (p *PrintOpts) GetPrinter() (print.Interface, error)
  • func (p *PrintOpts) MustPrintStructResult(result interface{})
  • func (p *PrintOpts) PrintResult(result *jnode.Node)
  • func (p *PrintOpts) Register(cmd *cobra.Command)
  • func (p *PrintOpts) SetColumnFunction(columnName string, computer print.ColumnFunction)
  • func (p *PrintOpts) SetFormatter(columnName string, formatter print.Formatter)

Functions

func AddPreRunE

func AddPreRunE(c *cobra.Command, f func(*cobra.Command, []string) error)

func GetClientOptionsGroupHelpCommand

func GetClientOptionsGroupHelpCommand() *cobra.Command

func GetPrintOptionsGroupHelpCommand

func GetPrintOptionsGroupHelpCommand() *cobra.Command

Types

type ClientOpts

type ClientOpts struct {
	APIConfig      api.Config
	DefaultTimeout int
	// contains filtered or unexported fields
}

func (*ClientOpts) ConfigureDefaultOrganization

func (opts *ClientOpts) ConfigureDefaultOrganization() error

func (*ClientOpts) GetAPIClient

func (opts *ClientOpts) GetAPIClient() (*api.Client, error)

func (*ClientOpts) GetClientOptionsGroup

func (opts *ClientOpts) GetClientOptionsGroup() *HiddenOptionsGroup

func (*ClientOpts) GetUnauthenticatedAPIClient

func (opts *ClientOpts) GetUnauthenticatedAPIClient() *api.Client

func (*ClientOpts) IsAuthenticated

func (opts *ClientOpts) IsAuthenticated() bool

func (*ClientOpts) MustGetAPIClient

func (opts *ClientOpts) MustGetAPIClient() *api.Client

func (*ClientOpts) Register

func (opts *ClientOpts) Register(cmd *cobra.Command)

func (*ClientOpts) RequireAuthentication

func (opts *ClientOpts) RequireAuthentication() error

func (*ClientOpts) SetContextValues

func (opts *ClientOpts) SetContextValues(context map[string]string)

func (*ClientOpts) ValidateOrganization

func (opts *ClientOpts) ValidateOrganization() error

type HiddenOptionsGroup

type HiddenOptionsGroup struct {
	Name            string
	Long            string
	Example         string
	CreateFlagsFunc func(*pflag.FlagSet)
}

func (*HiddenOptionsGroup) GetHelpCommand

func (group *HiddenOptionsGroup) GetHelpCommand() *cobra.Command

func (*HiddenOptionsGroup) Register

func (group *HiddenOptionsGroup) Register(cmd *cobra.Command)

type Interface

type Interface interface {
	Register(cmd *cobra.Command)
}

type PrintClientOpts

type PrintClientOpts struct {
	PrintOpts
	ClientOpts
}

func (*PrintClientOpts) Register

func (opts *PrintClientOpts) Register(cmd *cobra.Command)

func (*PrintClientOpts) SetContextValues

func (opts *PrintClientOpts) SetContextValues(context map[string]string)

type PrintOpts

type PrintOpts struct {
	OutputFormat        []string
	DefaultOutputFormat string
	NoHeaders           bool
	Wide                bool
	Path                []string
	Columns             []string
	WideColumns         []string
	DiffColumn          string
	VersionColumn       string
	SortBy              []string
	DefaultSortBy       []string
	Limit               int
	Filter              []string
	Template            []string
	Formatters          map[string]print.Formatter
	ComputedColumns     map[string]print.ColumnFunction
	DiffContextSize     int

	// This is a workaround for the inability of the table printer to
	// accumluate results across an array.  See tools/command.go for how
	// this is used.
	PrintTableDataTransform func(*jnode.Node) *jnode.Node
	// contains filtered or unexported fields
}

func (*PrintOpts) GetPrintOptionsGroup

func (p *PrintOpts) GetPrintOptionsGroup() *HiddenOptionsGroup

func (*PrintOpts) GetPrinter

func (p *PrintOpts) GetPrinter() (print.Interface, error)

func (*PrintOpts) MustPrintStructResult

func (p *PrintOpts) MustPrintStructResult(result interface{})

func (*PrintOpts) PrintResult

func (p *PrintOpts) PrintResult(result *jnode.Node)

func (*PrintOpts) Register

func (p *PrintOpts) Register(cmd *cobra.Command)

func (*PrintOpts) SetColumnFunction

func (p *PrintOpts) SetColumnFunction(columnName string, computer print.ColumnFunction)

func (*PrintOpts) SetFormatter

func (p *PrintOpts) SetFormatter(columnName string, formatter print.Formatter)