index

Documentation

Index

• type Index
  • func (index *Index) GetDescription() string
  • func (index *Index) GetFlagSet() *flag.FlagSet
  • func (index *Index) GetHelpFlag() *bool
  • func (index *Index) GetName() string
  • func (index *Index) GetSubCommands() []cli.Command
  • func (index *Index) Init(helpFlagName string, helpFlagDescription string)
  • func (index *Index) Process()

Types

type Index

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

Index deals with commands related to resource indexes

func (*Index) GetDescription

func (index *Index) GetDescription() string

GetDescription returns the description for the index command

func (*Index) GetFlagSet

func (index *Index) GetFlagSet() *flag.FlagSet

GetFlagSet returns a pointer to the flag.FlagSet associated to the command

func (*Index) GetHelpFlag

func (index *Index) GetHelpFlag() *bool

GetHelpFlag returns a pointer to the initialized help flag for the command

func (*Index) GetName

func (index *Index) GetName() string

GetName returns the value of the name constant

func (*Index) GetSubCommands

func (index *Index) GetSubCommands() []cli.Command

GetSubCommands returns a slice of subcommands under the index command (expect empty slice if none)

func (*Index) Init

func (index *Index) Init(helpFlagName string, helpFlagDescription string)

Init initializes the command object

func (*Index) Process

func (index *Index) Process()

Process does nothing, since this command has subcommands that actually do the processing