Documentation
¶
Overview ¶
Package agent provides the command to get agent information.
Index ¶
- Constants
- Variables
- func NewCommand(options CommandOptions) *cobra.Command
- type CommandOptions
- func (opt *CommandOptions) Get(cmd *cobra.Command, ids []string) error
- func (opt *CommandOptions) List(cmd *cobra.Command) error
- func (opt *CommandOptions) Prepare(*cobra.Command, []string) error
- func (opt *CommandOptions) Run(cmd *cobra.Command, args []string) error
- func (opt *CommandOptions) ValidArgsFunction(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)
- type ItemForCLI
Constants ¶
View Source
const (
// MaxCompletionResults is the maximum number of completion results to return.
MaxCompletionResults = 20
)
Variables ¶
View Source
var ( // ErrCommandExecutionFailed is returned when the command execution fails. ErrCommandExecutionFailed = errors.New("command execution failed") )
Functions ¶
func NewCommand ¶
func NewCommand(options CommandOptions) *cobra.Command
NewCommand creates a new agent command.
Types ¶
type CommandOptions ¶
type CommandOptions struct {
*config.GlobalConfig
// contains filtered or unexported fields
}
CommandOptions contains the options for the agent command.
func (*CommandOptions) Get ¶
func (opt *CommandOptions) Get(cmd *cobra.Command, ids []string) error
Get retrieves the agent information for the given agent UIDs.
func (*CommandOptions) List ¶
func (opt *CommandOptions) List(cmd *cobra.Command) error
List retrieves the list of agents.
func (*CommandOptions) Prepare ¶
func (opt *CommandOptions) Prepare(*cobra.Command, []string) error
Prepare prepares the command to run.
func (*CommandOptions) Run ¶
func (opt *CommandOptions) Run(cmd *cobra.Command, args []string) error
Run runs the command.
func (*CommandOptions) ValidArgsFunction ¶ added in v0.1.25
func (opt *CommandOptions) ValidArgsFunction( cmd *cobra.Command, _ []string, toComplete string, ) ([]string, cobra.ShellCompDirective)
ValidArgsFunction provides dynamic completion for agent instance UIDs.
type ItemForCLI ¶ added in v0.1.24
type ItemForCLI struct {
InstanceUID uuid.UUID `short:"Instance UID" text:"Instance UID"`
ConnectionType string `short:"Connection Type" text:"Connection Type"`
Connected bool `short:"Connected" text:"Connected"`
Healthy bool `short:"Healthy" text:"Healthy"`
SequenceNum uint64 `short:"Sequence Num" text:"Sequence Num"`
StartedAt string `short:"Started At" text:"Started At"`
LastReportedAt string `short:"Last Reported At" text:"Last Reported At"`
}
ItemForCLI is a struct that represents an agent item for display.
Source Files
Click to show internal directories.
Click to hide internal directories.