Documentation ¶
Index ¶
- func ValidateRowPrintHandlerFunc(printFunc reflect.Value) error
- type GenerateOptions
- type HumanReadableGenerator
- func (h *HumanReadableGenerator) GenerateTable(obj runtime.Object, options GenerateOptions) (*metav1beta1.Table, error)
- func (h *HumanReadableGenerator) TableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error
- func (h *HumanReadableGenerator) With(fns ...func(PrintHandler)) *HumanReadableGenerator
- type PrintHandler
- type ResourcePrinter
- type ResourcePrinterFunc
- type TableGenerator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateRowPrintHandlerFunc ¶
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 GenerateOptions) ([]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 GenerateOptions ¶
GenerateOptions encapsulates attributes for table generation.
type HumanReadableGenerator ¶
type HumanReadableGenerator struct {
// contains filtered or unexported fields
}
HumanReadableGenerator is an implementation of TableGenerator used to generate a table for a specific resource. The table is printed with a TablePrinter using PrintObj().
func NewTableGenerator ¶
func NewTableGenerator() *HumanReadableGenerator
NewTableGenerator creates a HumanReadableGenerator suitable for calling GenerateTable().
func (*HumanReadableGenerator) GenerateTable ¶
func (h *HumanReadableGenerator) GenerateTable(obj runtime.Object, options GenerateOptions) (*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 (*HumanReadableGenerator) TableHandler ¶
func (h *HumanReadableGenerator) TableHandler(columnDefinitions []metav1beta1.TableColumnDefinition, printFunc interface{}) error
TableHandler adds a print handler with a given set of columns to HumanReadableGenerator instance. See ValidateRowPrintHandlerFunc for required method signature.
func (*HumanReadableGenerator) With ¶
func (h *HumanReadableGenerator) With(fns ...func(PrintHandler)) *HumanReadableGenerator
With method - accepts a list of builder functions that modify HumanReadableGenerator
type PrintHandler ¶
type PrintHandler interface {
TableHandler(columns []metav1beta1.TableColumnDefinition, printFunc interface{}) error
}
PrintHandler - interface to handle printing provided an array of metav1beta1.TableColumnDefinition
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 ¶
type TableGenerator interface {
GenerateTable(obj runtime.Object, options GenerateOptions) (*metav1beta1.Table, error)
}
TableGenerator - an interface for generating metav1beta1.Table provided a runtime.Object