output

Documentation

Index

• func BindFlags(flags *pflag.FlagSet)
• func BindFlagsSimple(flags *pflag.FlagSet)
• func BoolPointerString(b *bool, falseString, trueString, nilString string) string
• func ClearOutputFlagDefault(cmd *cobra.Command)
• func Describe(fn func(d *Describer)) string
• func DescribeBackup(backup *velerov1api.Backup, deleteRequests []velerov1api.DeleteBackupRequest, ...) string
• func DescribeBackupSpec(d *Describer, spec velerov1api.BackupSpec)
• func DescribeBackupStatus(d *Describer, backup *velerov1api.Backup, details bool, ...)
• func DescribeDeleteBackupRequests(d *Describer, requests []velerov1api.DeleteBackupRequest)
• func DescribePodVolumeBackups(d *Describer, backups []velerov1api.PodVolumeBackup, details bool)
• func DescribeRestore(restore *v1.Restore, podVolumeRestores []v1.PodVolumeRestore, details bool, ...) string
• func DescribeSchedule(schedule *v1.Schedule) string
• func DescribeScheduleSpec(d *Describer, spec v1.ScheduleSpec)
• func DescribeScheduleStatus(d *Describer, status v1.ScheduleStatus)
• func GetLabelColumnsValues(cmd *cobra.Command) []string
• func GetOutputFlagValue(cmd *cobra.Command) string
• func GetShowLabelsValue(cmd *cobra.Command) bool
• func NewPrinter(cmd *cobra.Command) (*printers.HumanReadablePrinter, error)
• func PrintWithFormat(c *cobra.Command, obj runtime.Object) (bool, error)
• func ValidateFlags(cmd *cobra.Command) error
• type Describer
  • func (d *Describer) DescribeMap(name string, m map[string]string)
  • func (d *Describer) DescribeMetadata(metadata metav1.ObjectMeta)
  • func (d *Describer) DescribeSlice(preindent int, name string, s []string)
  • func (d *Describer) Printf(msg string, args ...interface{})
  • func (d *Describer) Println(args ...interface{})

Functions

func BindFlags

func BindFlags(flags *pflag.FlagSet)

BindFlags defines a set of output-specific flags within the provided FlagSet.

func BindFlagsSimple

func BindFlagsSimple(flags *pflag.FlagSet)

BindFlagsSimple defines the output format flag only.

func BoolPointerString

func BoolPointerString(b *bool, falseString, trueString, nilString string) string

BoolPointerString returns the appropriate string based on the bool pointer's value.

func ClearOutputFlagDefault

func ClearOutputFlagDefault(cmd *cobra.Command)

ClearOutputFlagDefault sets the current and default value of the "output" flag to the empty string.

func Describe

func Describe(fn func(d *Describer)) string

func DescribeBackup

func DescribeBackup(
	backup *velerov1api.Backup,
	deleteRequests []velerov1api.DeleteBackupRequest,
	podVolumeBackups []velerov1api.PodVolumeBackup,
	details bool,
	veleroClient clientset.Interface,
) string

DescribeBackup describes a backup in human-readable format.

func DescribeBackupSpec

func DescribeBackupSpec(d *Describer, spec velerov1api.BackupSpec)

DescribeBackupSpec describes a backup spec in human-readable format.

func DescribeBackupStatus

func DescribeBackupStatus(d *Describer, backup *velerov1api.Backup, details bool, veleroClient clientset.Interface)

DescribeBackupStatus describes a backup status in human-readable format.

func DescribeDeleteBackupRequests

func DescribeDeleteBackupRequests(d *Describer, requests []velerov1api.DeleteBackupRequest)

DescribeDeleteBackupRequests describes delete backup requests in human-readable format.

func DescribePodVolumeBackups

func DescribePodVolumeBackups(d *Describer, backups []velerov1api.PodVolumeBackup, details bool)

DescribePodVolumeBackups describes pod volume backups in human-readable format.

func DescribeRestore

func DescribeRestore(restore *v1.Restore, podVolumeRestores []v1.PodVolumeRestore, details bool, veleroClient clientset.Interface) string

func DescribeSchedule

func DescribeSchedule(schedule *v1.Schedule) string

func DescribeScheduleSpec

func DescribeScheduleSpec(d *Describer, spec v1.ScheduleSpec)

func DescribeScheduleStatus

func DescribeScheduleStatus(d *Describer, status v1.ScheduleStatus)

func GetLabelColumnsValues

func GetLabelColumnsValues(cmd *cobra.Command) []string

GetLabelColumnsValues returns the value of the "label-columns" flag in the provided command, or the zero value if not present.

func GetOutputFlagValue

func GetOutputFlagValue(cmd *cobra.Command) string

GetOutputFlagValue returns the value of the "output" flag in the provided command, or the zero value if not present.

func GetShowLabelsValue

func GetShowLabelsValue(cmd *cobra.Command) bool

GetShowLabelsValue returns the value of the "show-labels" flag in the provided command, or the zero value if not present.

func NewPrinter

func NewPrinter(cmd *cobra.Command) (*printers.HumanReadablePrinter, error)

NewPrinter returns a printer for doing human-readable table printing of Velero objects.

func PrintWithFormat

func PrintWithFormat(c *cobra.Command, obj runtime.Object) (bool, error)

PrintWithFormat prints the provided object in the format specified by the command's flags.

func ValidateFlags

func ValidateFlags(cmd *cobra.Command) error

ValidateFlags returns an error if any of the output-related flags were specified with invalid values, or nil otherwise.

Types

type Describer

type Describer struct {
	Prefix string
	// contains filtered or unexported fields
}

func (*Describer) DescribeMap

func (d *Describer) DescribeMap(name string, m map[string]string)

DescribeMap describes a map of key-value pairs using name as the heading.

func (*Describer) DescribeMetadata

func (d *Describer) DescribeMetadata(metadata metav1.ObjectMeta)

DescribeMetadata describes standard object metadata in a consistent manner.

func (*Describer) DescribeSlice

func (d *Describer) DescribeSlice(preindent int, name string, s []string)

DescribeSlice describes a slice of strings using name as the heading. The output is prefixed by "preindent" number of tabs.

func (*Describer) Printf

func (d *Describer) Printf(msg string, args ...interface{})

func (*Describer) Println

func (d *Describer) Println(args ...interface{})