output

package
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 28, 2024 License: Apache-2.0 Imports: 35 Imported by: 38

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BindFlags 

func BindFlags(flags *pflag.FlagSet)

BindFlags defines a set of output-specific flags within the provided FlagSet.

func BindFlagsSimple added in v1.0.1 

func BindFlagsSimple(flags *pflag.FlagSet)

BindFlagsSimple defines the output format flag only.

func BoolPointerString added in v0.6.0 

func BoolPointerString(b *bool, falseString, trueString, nilString string) string

BoolPointerString returns the appropriate string based on the bool pointer's value.

func ClearOutputFlagDefault 

func ClearOutputFlagDefault(cmd *cobra.Command)

ClearOutputFlagDefault sets the current and default value of the "output" flag to the empty string.

func Describe added in v0.6.0 

func Describe(fn func(d *Describer)) string

func DescribeBackup added in v0.6.0 

func DescribeBackup(
	ctx context.Context,
	kbClient kbclient.Client,
	backup *velerov1api.Backup,
	deleteRequests []velerov1api.DeleteBackupRequest,
	podVolumeBackups []velerov1api.PodVolumeBackup,
	details bool,
	insecureSkipTLSVerify bool,
	caCertFile string,
) string

DescribeBackup describes a backup in human-readable format.

func DescribeBackupInSF added in v1.11.0 

func DescribeBackupInSF(
	ctx context.Context,
	kbClient kbclient.Client,
	backup *velerov1api.Backup,
	deleteRequests []velerov1api.DeleteBackupRequest,
	podVolumeBackups []velerov1api.PodVolumeBackup,
	details bool,
	insecureSkipTLSVerify bool,
	caCertFile string,
	outputFormat string,
) string

DescribeBackupInSF describes a backup in structured format.

func DescribeBackupResults added in v1.11.0 

func DescribeBackupResults(ctx context.Context, kbClient kbclient.Client, d *Describer, backup *velerov1api.Backup, insecureSkipTLSVerify bool, caCertPath string)

DescribeBackupResults describes errors and warnings in human-readable format.

func DescribeBackupResultsInSF added in v1.11.0 

func DescribeBackupResultsInSF(ctx context.Context, kbClient kbclient.Client, d *StructuredDescriber, backup *velerov1api.Backup, insecureSkipTLSVerify bool, caCertPath string)

DescribeBackupResultsInSF describes errors and warnings in structured format.

func DescribeBackupSpec added in v0.6.0 

func DescribeBackupSpec(d *Describer, spec velerov1api.BackupSpec)

DescribeBackupSpec describes a backup spec in human-readable format.

func DescribeBackupSpecInSF added in v1.11.0 

func DescribeBackupSpecInSF(d *StructuredDescriber, spec velerov1api.BackupSpec)

DescribeBackupSpecInSF describes a backup spec in structured format.

func DescribeBackupStatus added in v0.6.0 

func DescribeBackupStatus(ctx context.Context, kbClient kbclient.Client, d *Describer, backup *velerov1api.Backup, details bool,
	insecureSkipTLSVerify bool, caCertPath string, podVolumeBackups []velerov1api.PodVolumeBackup)

DescribeBackupStatus describes a backup status in human-readable format.

func DescribeBackupStatusInSF added in v1.11.0 

func DescribeBackupStatusInSF(ctx context.Context, kbClient kbclient.Client, d *StructuredDescriber, backup *velerov1api.Backup, details bool,
	insecureSkipTLSVerify bool, caCertPath string, podVolumeBackups []velerov1api.PodVolumeBackup)

DescribeBackupStatusInSF describes a backup status in structured format.

func DescribeDeleteBackupRequests added in v0.8.0 

func DescribeDeleteBackupRequests(d *Describer, requests []velerov1api.DeleteBackupRequest)

DescribeDeleteBackupRequests describes delete backup requests in human-readable format.

func DescribeDeleteBackupRequestsInSF added in v1.11.0 

func DescribeDeleteBackupRequestsInSF(d *StructuredDescriber, requests []velerov1api.DeleteBackupRequest)

DescribeDeleteBackupRequestsInSF describes delete backup requests in structured format.

func DescribeInSF added in v1.11.0 

func DescribeInSF(fn func(d *StructuredDescriber), format string) string

DescribeInSF returns the structured output based on the func that applies StructuredDescriber to collect outputs. This function takes arg 'format' for future format extension.

func DescribeResourceModifier added in v1.15.0 

func DescribeResourceModifier(d *Describer, resModifier *v1.TypedLocalObjectReference)

DescribeResourceModifier describes resource policies in human-readable format

func DescribeResourcePolicies added in v1.11.0 

func DescribeResourcePolicies(d *Describer, resPolicies *v1.TypedLocalObjectReference)

DescribeResourcePolicies describes resource policies in human-readable format

func DescribeResourcePoliciesInSF added in v1.11.0 

func DescribeResourcePoliciesInSF(d *StructuredDescriber, resPolicies *v1.TypedLocalObjectReference)

DescribeResourcePoliciesInSF describes resource policies in structured format.

func DescribeRestore added in v0.6.0 

func DescribeRestore(
	ctx context.Context,
	kbClient kbclient.Client,
	restore *velerov1api.Restore,
	podVolumeRestores []velerov1api.PodVolumeRestore,
	details bool,
	insecureSkipTLSVerify bool,
	caCertFile string,
) string

func DescribeSchedule added in v0.6.0 

func DescribeSchedule(schedule *v1.Schedule) string

func DescribeScheduleSpec added in v0.6.0 

func DescribeScheduleSpec(d *Describer, spec v1.ScheduleSpec)

func DescribeScheduleStatus added in v0.6.0 

func DescribeScheduleStatus(d *Describer, status v1.ScheduleStatus)

func DescribeUploaderConfigForBackup added in v1.13.0 

func DescribeUploaderConfigForBackup(d *Describer, spec velerov1api.BackupSpec)

DescribeUploaderConfigForBackup describes uploader config in human-readable format

func GetLabelColumnsValues 

func GetLabelColumnsValues(cmd *cobra.Command) []string

GetLabelColumnsValues returns the value of the "label-columns" flag in the provided command, or the zero value if not present.

func GetOutputFlagValue 

func GetOutputFlagValue(cmd *cobra.Command) string

GetOutputFlagValue returns the value of the "output" flag in the provided command, or the zero value if not present.

func GetShowLabelsValue 

func GetShowLabelsValue(cmd *cobra.Command) bool

GetShowLabelsValue returns the value of the "show-labels" flag in the provided command, or the zero value if not present.

func NewPrinter 

func NewPrinter(cmd *cobra.Command) (printers.ResourcePrinter, error)

NewPrinter returns a printer for doing human-readable table printing of Velero objects.

func PrintWithFormat 

func PrintWithFormat(c *cobra.Command, obj runtime.Object) (bool, error)

PrintWithFormat prints the provided object in the format specified by the command's flags.

func ValidateFlags 

func ValidateFlags(cmd *cobra.Command) error

ValidateFlags returns an error if any of the output-related flags were specified with invalid values, or nil otherwise.

Types

type Describer added in v0.6.0 

type Describer struct {
	Prefix string
	// contains filtered or unexported fields
}

func (*Describer) DescribeMap added in v0.6.0 

func (d *Describer) DescribeMap(name string, m map[string]string)

DescribeMap describes a map of key-value pairs using name as the heading.

func (*Describer) DescribeMetadata added in v0.6.0 

func (d *Describer) DescribeMetadata(metadata metav1.ObjectMeta)

DescribeMetadata describes standard object metadata in a consistent manner.

func (*Describer) DescribeSlice added in v0.6.0 

func (d *Describer) DescribeSlice(preindent int, name string, s []string)

DescribeSlice describes a slice of strings using name as the heading. The output is prefixed by "preindent" number of tabs.

func (*Describer) Printf added in v0.6.0 

func (d *Describer) Printf(msg string, args ...interface{})

func (*Describer) Println added in v0.6.0 

func (d *Describer) Println(args ...interface{})

type StructuredDescriber added in v1.11.0 

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

func NewStructuredDescriber added in v1.11.0 

func NewStructuredDescriber(format string) *StructuredDescriber

NewStructuredDescriber creates a StructuredDescriber.

func (*StructuredDescriber) Describe added in v1.11.0 

func (d *StructuredDescriber) Describe(name string, arg interface{})

Describe adds all types of argument to d.output.

func (*StructuredDescriber) DescribeMetadata added in v1.11.0 

func (d *StructuredDescriber) DescribeMetadata(metadata metav1.ObjectMeta)

DescribeMetadata describes standard object metadata.

func (*StructuredDescriber) JSONEncode added in v1.12.0 

func (d *StructuredDescriber) JSONEncode() string

JSONEncode encodes d.output to json

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.