Documentation
¶
Index ¶
- func NewCmdGet(parent string, f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- type GetOptions
- type HumanPrintFlags
- func (f *HumanPrintFlags) AddFlags(c *cobra.Command)
- func (f *HumanPrintFlags) AllowedFormats() []string
- func (f *HumanPrintFlags) EnsureWithKind() error
- func (f *HumanPrintFlags) EnsureWithNamespace() error
- func (f *HumanPrintFlags) SetKind(kind schema.GroupKind)
- func (f *HumanPrintFlags) ToPrinter(outputFormat string) (printers.ResourcePrinter, error)
- type PrintFlags
- func (f *PrintFlags) AddFlags(cmd *cobra.Command)
- func (f *PrintFlags) AllowedFormats() []string
- func (f *PrintFlags) Copy() PrintFlags
- func (f *PrintFlags) EnsureWithKind() error
- func (f *PrintFlags) EnsureWithNamespace() error
- func (f *PrintFlags) SetKind(kind schema.GroupKind)
- func (f *PrintFlags) ToPrinter() (printers.ResourcePrinter, error)
- func (f *PrintFlags) UseOpenAPIColumns(api openapi.Resources, mapping *meta.RESTMapping) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type GetOptions ¶
type GetOptions struct {
PrintFlags *PrintFlags
ToPrinter func(*meta.RESTMapping, bool) (printers.ResourcePrinterFunc, error)
IsHumanReadablePrinter bool
PrintWithOpenAPICols bool
CmdParent string
resource.FilenameOptions
Raw string
Watch bool
WatchOnly bool
ChunkSize int64
LabelSelector string
FieldSelector string
AllNamespaces bool
Namespace string
ExplicitNamespace bool
ServerPrint bool
NoHeaders bool
Sort bool
IgnoreNotFound bool
Export bool
IncludeUninitialized bool
genericclioptions.IOStreams
}
GetOptions contains the input to the get command.
func NewGetOptions ¶
func NewGetOptions(parent string, streams genericclioptions.IOStreams) *GetOptions
NewGetOptions returns a GetOptions with default chunk size 500.
func (*GetOptions) Complete ¶
Complete takes the command arguments and factory and infers any remaining options.
type HumanPrintFlags ¶
type HumanPrintFlags struct {
ShowKind *bool
ShowLabels *bool
SortBy *string
ColumnLabels *[]string
// get.go-specific values
NoHeaders bool
Kind schema.GroupKind
AbsoluteTimestamps bool
WithNamespace bool
}
HumanPrintFlags provides default flags necessary for printing. Given the following flag values, a printer can be requested that knows how to handle printing based on these values.
func NewHumanPrintFlags ¶
func NewHumanPrintFlags() *HumanPrintFlags
NewHumanPrintFlags returns flags associated with human-readable printing, with default values set.
func (*HumanPrintFlags) AddFlags ¶
func (f *HumanPrintFlags) AddFlags(c *cobra.Command)
AddFlags receives a *cobra.Command reference and binds flags related to human-readable printing to it
func (*HumanPrintFlags) AllowedFormats ¶
func (f *HumanPrintFlags) AllowedFormats() []string
func (*HumanPrintFlags) EnsureWithKind ¶
func (f *HumanPrintFlags) EnsureWithKind() error
EnsureWithKind sets the "Showkind" humanreadable option to true.
func (*HumanPrintFlags) EnsureWithNamespace ¶
func (f *HumanPrintFlags) EnsureWithNamespace() error
EnsureWithNamespace sets the "WithNamespace" humanreadable option to true.
func (*HumanPrintFlags) SetKind ¶
func (f *HumanPrintFlags) SetKind(kind schema.GroupKind)
SetKind sets the Kind option
func (*HumanPrintFlags) ToPrinter ¶
func (f *HumanPrintFlags) ToPrinter(outputFormat string) (printers.ResourcePrinter, error)
ToPrinter receives an outputFormat and returns a printer capable of handling human-readable output.
type PrintFlags ¶
type PrintFlags struct {
JSONYamlPrintFlags *genericclioptions.JSONYamlPrintFlags
NamePrintFlags *genericclioptions.NamePrintFlags
CustomColumnsFlags *printers.CustomColumnsPrintFlags
HumanReadableFlags *HumanPrintFlags
TemplateFlags *genericclioptions.KubeTemplatePrintFlags
NoHeaders *bool
OutputFormat *string
}
PrintFlags composes common printer flag structs used in the Get command.
func NewGetPrintFlags ¶
func NewGetPrintFlags() *PrintFlags
NewGetPrintFlags returns flags associated with humanreadable, template, and "name" printing, with default values set.
func (*PrintFlags) AddFlags ¶
func (f *PrintFlags) AddFlags(cmd *cobra.Command)
AddFlags receives a *cobra.Command reference and binds flags related to humanreadable and template printing.
func (*PrintFlags) AllowedFormats ¶
func (f *PrintFlags) AllowedFormats() []string
func (*PrintFlags) Copy ¶
func (f *PrintFlags) Copy() PrintFlags
Copy returns a copy of PrintFlags for mutation
func (*PrintFlags) EnsureWithKind ¶
func (f *PrintFlags) EnsureWithKind() error
EnsureWithKind ensures that humanreadable flags return a printer capable of including resource kinds.
func (*PrintFlags) EnsureWithNamespace ¶
func (f *PrintFlags) EnsureWithNamespace() error
EnsureWithNamespace ensures that humanreadable flags return a printer capable of printing with a "namespace" column.
func (*PrintFlags) SetKind ¶
func (f *PrintFlags) SetKind(kind schema.GroupKind)
SetKind sets the Kind option of humanreadable flags
func (*PrintFlags) ToPrinter ¶
func (f *PrintFlags) ToPrinter() (printers.ResourcePrinter, error)
ToPrinter attempts to find a composed set of PrintFlags suitable for returning a printer based on current flag values.
func (*PrintFlags) UseOpenAPIColumns ¶
func (f *PrintFlags) UseOpenAPIColumns(api openapi.Resources, mapping *meta.RESTMapping) error
UseOpenAPIColumns modifies the output format, as well as the "allowMissingKeys" option for template printers, to values defined in the OpenAPI schema of a resource.
Source Files