mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-11-04 07:49:35 +00:00
f768a63fb0
Get command now uses metadata x-kubernetes-print-columns, if present, in Openapi schema to format output for a resource. This functionality is guarded by a boolean flag 'use-openapi-print-columns'.
113 lines
3.4 KiB
Go
113 lines
3.4 KiB
Go
/*
|
|
Copyright 2017 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package printers
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
)
|
|
|
|
// ResourcePrinter is an interface that knows how to print runtime objects.
|
|
type ResourcePrinter interface {
|
|
// Print receives a runtime object, formats it and prints it to a writer.
|
|
PrintObj(runtime.Object, io.Writer) error
|
|
HandledResources() []string
|
|
//Can be used to print out warning/clarifications if needed
|
|
//after all objects were printed
|
|
AfterPrint(io.Writer, string) error
|
|
// Identify if it is a generic printer
|
|
IsGeneric() bool
|
|
}
|
|
|
|
// ResourcePrinterFunc is a function that can print objects
|
|
type ResourcePrinterFunc func(runtime.Object, io.Writer) error
|
|
|
|
// PrintObj implements ResourcePrinter
|
|
func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error {
|
|
return fn(obj, w)
|
|
}
|
|
|
|
// TODO: implement HandledResources()
|
|
func (fn ResourcePrinterFunc) HandledResources() []string {
|
|
return []string{}
|
|
}
|
|
|
|
func (fn ResourcePrinterFunc) AfterPrint(io.Writer, string) error {
|
|
return nil
|
|
}
|
|
|
|
func (fn ResourcePrinterFunc) IsGeneric() bool {
|
|
return true
|
|
}
|
|
|
|
type PrintOptions struct {
|
|
NoHeaders bool
|
|
WithNamespace bool
|
|
WithKind bool
|
|
Wide bool
|
|
ShowAll bool
|
|
ShowLabels bool
|
|
AbsoluteTimestamps bool
|
|
Kind string
|
|
ColumnLabels []string
|
|
}
|
|
|
|
// Describer generates output for the named resource or an error
|
|
// if the output could not be generated. Implementers typically
|
|
// abstract the retrieval of the named object from a remote server.
|
|
type Describer interface {
|
|
Describe(namespace, name string, describerSettings DescriberSettings) (output string, err error)
|
|
}
|
|
|
|
// DescriberSettings holds display configuration for each object
|
|
// describer to control what is printed.
|
|
type DescriberSettings struct {
|
|
ShowEvents bool
|
|
}
|
|
|
|
// ObjectDescriber is an interface for displaying arbitrary objects with extra
|
|
// information. Use when an object is in hand (on disk, or already retrieved).
|
|
// Implementers may ignore the additional information passed on extra, or use it
|
|
// by default. ObjectDescribers may return ErrNoDescriber if no suitable describer
|
|
// is found.
|
|
type ObjectDescriber interface {
|
|
DescribeObject(object interface{}, extra ...interface{}) (output string, err error)
|
|
}
|
|
|
|
// ErrNoDescriber is a structured error indicating the provided object or objects
|
|
// cannot be described.
|
|
type ErrNoDescriber struct {
|
|
Types []string
|
|
}
|
|
|
|
// Error implements the error interface.
|
|
func (e ErrNoDescriber) Error() string {
|
|
return fmt.Sprintf("no describer has been defined for %v", e.Types)
|
|
}
|
|
|
|
// OutputOptions represents resource output options which is used to generate a resource printer.
|
|
type OutputOptions struct {
|
|
// supported Format types can be found in pkg/printers/printers.go
|
|
FmtType string
|
|
FmtArg string
|
|
|
|
// indicates if it is OK to ignore missing keys for rendering an output template.
|
|
AllowMissingKeys bool
|
|
}
|