Documentation
¶
Index ¶
- func GetNewTabWriter(output io.Writer) *tabwriter.Writer
- func PrintTable(table *metav1beta1.Table, output io.Writer, options PrintOptions) error
- func ValidateRowPrintHandlerFunc(printFunc reflect.Value) error
- type HumanReadablePrinter
- func (h *HumanReadablePrinter) DefaultTableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error
- 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 (a *HumanReadablePrinter) With(fns ...func(PrintHandler)) *HumanReadablePrinter
- type PrintHandler
- type PrintOptions
- type ResourcePrinter
- type ResourcePrinterFunc
- type TableGenerator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetNewTabWriter ¶
GetNewTabWriter returns a tabwriter that translates tabbed columns in input into properly aligned text.
func PrintTable ¶ added in v1.7.0
func PrintTable(table *metav1beta1.Table, output io.Writer, options PrintOptions) error
PrintTable prints a table to the provided output respecting the filtering rules for options for wide columns and filtered rows. It filters out rows that are Completed. You should call decorateTable if you receive a table from a remote server before calling PrintTable.
func ValidateRowPrintHandlerFunc ¶ added in v1.7.0
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 NewHumanReadablePrinter ¶
func NewHumanReadablePrinter(options PrintOptions) *HumanReadablePrinter
NewHumanReadablePrinter 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 NewTableGenerator ¶ added in v1.15.0
func NewTableGenerator() *HumanReadablePrinter
NewTableGenerator creates a HumanReadablePrinter suitable for calling GenerateTable().
func (*HumanReadablePrinter) DefaultTableHandler ¶ added in v1.8.0
func (h *HumanReadablePrinter) DefaultTableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error
DefaultTableHandler registers a set of columns and a print func that is given a chance to process any object without an explicit handler. Only the most recently set print handler is used. See ValidateRowPrintHandlerFunc for required method signature.
func (*HumanReadablePrinter) GenerateTable ¶ added in v1.15.0
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 ¶
PrintObj prints the obj in a human-friendly format according to the type of the obj.
func (*HumanReadablePrinter) TableHandler ¶ added in v1.7.0
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 ¶ added in v1.7.0
func (a *HumanReadablePrinter) With(fns ...func(PrintHandler)) *HumanReadablePrinter
type PrintHandler ¶ added in v1.7.0
type PrintHandler interface { TableHandler(columns []metav1beta1.TableColumnDefinition, printFunc interface{}) error DefaultTableHandler(columns []metav1beta1.TableColumnDefinition, printFunc interface{}) error }
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 }
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 ¶
ResourcePrinterFunc is a function that can print objects
type TableGenerator ¶ added in v1.15.0
type TableGenerator interface {
GenerateTable(obj runtime.Object, options PrintOptions) (*metav1beta1.Table, error)
}