printers

Documentation

Index

• func GetNewTabWriter(output io.Writer) *tabwriter.Writer
• func TranslateTimestampSince(timestamp metav1.Time) string
• func TranslateTimestampUntil(timestamp metav1.Time) string
• func ValidateRowPrintHandlerFunc(printFunc reflect.Value) error
• type HumanReadablePrinter
  • func NewTableGenerator() *HumanReadablePrinter
  • func NewTablePrinter(options PrintOptions) *HumanReadablePrinter
  • func (h *HumanReadablePrinter) GenerateTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error)
  • func (h *HumanReadablePrinter) PrintObj(obj runtime.Object, output io.Writer) error
  • func (h *HumanReadablePrinter) TableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error
  • func (h *HumanReadablePrinter) With(fns ...func(PrintHandler)) *HumanReadablePrinter
• type PrintHandler
• type PrintOptions
• type ResourcePrinter
• type ResourcePrinterFunc
  • func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error
• type TableGenerator

Functions

func GetNewTabWriter

func GetNewTabWriter(output io.Writer) *tabwriter.Writer

GetNewTabWriter returns a tabwriter that translates tabbed columns in input into properly aligned text.

func TranslateTimestampSince

func TranslateTimestampSince(timestamp metav1.Time) string

TranslateTimestampSince returns the elapsed time since timestamp in human-readable approximation.

func TranslateTimestampUntil

func TranslateTimestampUntil(timestamp metav1.Time) string

TranslateTimestampUntil returns the elapsed time until timestamp in human-readable approximation.

func ValidateRowPrintHandlerFunc

func ValidateRowPrintHandlerFunc(printFunc reflect.Value) error

ValidateRowPrintHandlerFunc validates print handler signature. printFunc is the function that will be called to print an object. It must be of the following type:

func printFunc(object ObjectType, options PrintOptions) ([]metav1beta1.TableRow, error)

where ObjectType is the type of the object that will be printed, and the first return value is an array of rows, with each row containing a number of cells that match the number of columns defined for that printer function.

Types

type HumanReadablePrinter

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

HumanReadablePrinter is an implementation of ResourcePrinter which attempts to provide more elegant output. It is not threadsafe, but you may call PrintObj repeatedly; headers will only be printed if the object type changes. This makes it useful for printing items received from watches.

func NewTableGenerator

func NewTableGenerator() *HumanReadablePrinter

NewTableGenerator creates a HumanReadablePrinter suitable for calling GenerateTable().

func NewTablePrinter

func NewTablePrinter(options PrintOptions) *HumanReadablePrinter

NewTablePrinter creates a printer suitable for calling PrintObj(). TODO(seans3): Change return type to ResourcePrinter interface once we no longer need to constuct the "handlerMap".

func (*HumanReadablePrinter) GenerateTable

func (h *HumanReadablePrinter) GenerateTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error)

GenerateTable returns a table for the provided object, using the printer registered for that type. It returns a table that includes all of the information requested by options, but will not remove rows or columns. The caller is responsible for applying rules related to filtering rows or columns.

func (*HumanReadablePrinter) PrintObj

func (h *HumanReadablePrinter) PrintObj(obj runtime.Object, output io.Writer) error

PrintObj prints the obj in a human-friendly format according to the type of the obj.

func (*HumanReadablePrinter) TableHandler

func (h *HumanReadablePrinter) TableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error

TableHandler adds a print handler with a given set of columns to HumanReadablePrinter instance. See ValidateRowPrintHandlerFunc for required method signature.

func (*HumanReadablePrinter) With

func (h *HumanReadablePrinter) With(fns ...func(PrintHandler)) *HumanReadablePrinter

With method - accepts a list of builder functions that modify HumanReadablePrinter

type PrintHandler

type PrintHandler interface {
	TableHandler(columns []metav1beta1.TableColumnDefinition, printFunc interface{}) error
}

PrintHandler - interface to handle printing provided an array of metav1beta1.TableColumnDefinition

type PrintOptions

type PrintOptions struct {
	// supported Format types can be found in pkg/printers/printers.go
	OutputFormatType     string
	OutputFormatArgument string

	NoHeaders          bool
	WithNamespace      bool
	WithKind           bool
	Wide               bool
	ShowLabels         bool
	AbsoluteTimestamps bool
	Kind               schema.GroupKind
	ColumnLabels       []string

	SortBy string

	// indicates if it is OK to ignore missing keys for rendering an output template.
	AllowMissingKeys bool
}

PrintOptions struct defines a struct for various print options

type ResourcePrinter

type ResourcePrinter interface {
	// Print receives a runtime object, formats it and prints it to a writer.
	PrintObj(runtime.Object, io.Writer) error
}

ResourcePrinter is an interface that knows how to print runtime objects.

type ResourcePrinterFunc

type ResourcePrinterFunc func(runtime.Object, io.Writer) error

ResourcePrinterFunc is a function that can print objects

func (ResourcePrinterFunc) PrintObj

func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error

PrintObj implements ResourcePrinter

type TableGenerator

type TableGenerator interface {
	GenerateTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error)
}

TableGenerator - an interface for generating metav1beta1.Table provided a runtime.Object