list

Documentation

Index

• Variables
• func NewCmd() *cobra.Command
• type ColumnEnum
  • func (c *ColumnEnum) Set(v string) error
  • func (c *ColumnEnum) String() string
  • func (c *ColumnEnum) Type() string
• type ListOptions
  • func NewListOptions() *ListOptions

Variables

var (

	// The tags that will be excluded by default, if the user does not pass any
	// others to the list command.
	DefaultExcludedTags = []string{
		"canary",
	}
)

Functions

func NewCmd

func NewCmd() *cobra.Command

Types

type ColumnEnum

type ColumnEnum string

From: https://stackoverflow.com/questions/50824554/permitted-flag-values-for-cobra

const (
	ColumnID        ColumnEnum = "id"
	ColumnCreatedAt ColumnEnum = "created_at"
)

func (*ColumnEnum) Set

func (c *ColumnEnum) Set(v string) error

Set must have pointer receiver so it doesn't change the value of a copy

func (*ColumnEnum) String

func (c *ColumnEnum) String() string

func (*ColumnEnum) Type

func (c *ColumnEnum) Type() string

Type is only used in help text

type ListOptions

type ListOptions struct {
	IDFilter    string               // Filter by Job List to IDs matching substring.
	IncludeTags []string             // Only return jobs with these annotations
	ExcludeTags []string             // Only return jobs without these annotations
	MaxJobs     int                  // Print the first NUM jobs instead of the first 10.
	OutputOpts  output.OutputOptions // The output format for the list of jobs (json or text)
	SortReverse bool                 // Reverse order of table - for time sorting, this will be newest first.
	SortBy      ColumnEnum           // Sort by field, defaults to creation time, with newest first [Allowed "id", "created_at"].
	ReturnAll   bool                 // Return all jobs, not just those that belong to the user
}

func NewListOptions

func NewListOptions() *ListOptions