printer

package

v0.8.18 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/flyteorg/flytectl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func FormatParameterDescriptions(parameterMap map[string]*core.Parameter)
func FormatVariableDescriptions(variableMap map[string]*core.Variable)
func OutputFormats() []string
type Column
type OutputFormat
- func OutputFormatString(s string) (OutputFormat, error)
- func OutputFormatValues() []OutputFormat
type PrintableProto
- func (p PrintableProto) MarshalJSON() ([]byte, error)
type Printer

Constants ¶

View Source

const (
	DefaultFormattedDescriptionsKey = "_formatted_descriptions"
)

View Source

const GraphVisualizationServiceURL = "http://graph.flyte.org/#"

Variables ¶

This section is empty.

Functions ¶

func FormatParameterDescriptions ¶ added in v0.2.26

func FormatParameterDescriptions(parameterMap map[string]*core.Parameter)

func FormatVariableDescriptions ¶ added in v0.2.26

func FormatVariableDescriptions(variableMap map[string]*core.Variable)

func OutputFormats ¶

func OutputFormats() []string

Types ¶

type Column ¶

type Column struct {
	Header   string
	JSONPath string
	// Optional Truncation directive to limit content. This will simply truncate the string output.
	TruncateTo *int
}

type OutputFormat ¶

type OutputFormat uint8

const (
	OutputFormatTABLE OutputFormat = iota
	OutputFormatJSON
	OutputFormatYAML
	OutputFormatDOT
	OutputFormatDOTURL
)

func OutputFormatString ¶

func OutputFormatString(s string) (OutputFormat, error)

OutputFormatString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func OutputFormatValues ¶

func OutputFormatValues() []OutputFormat

OutputFormatValues returns all values of the enum

func (OutputFormat) IsAOutputFormat ¶

func (i OutputFormat) IsAOutputFormat() bool

IsAOutputFormat returns "true" if the value is listed in the enum definition. "false" otherwise

func (OutputFormat) MarshalJSON ¶

func (i OutputFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for OutputFormat

func (OutputFormat) MarshalYAML ¶

func (i OutputFormat) MarshalYAML() (interface{}, error)

MarshalYAML implements a YAML Marshaler for OutputFormat

func (*OutputFormat) Set ¶ added in v0.3.24

func (i *OutputFormat) Set(val string) error

Set implements PFlag's Value interface to attempt to set the value of the flag from string.

func (OutputFormat) String ¶

func (i OutputFormat) String() string

func (OutputFormat) Type ¶ added in v0.3.24

func (i OutputFormat) Type() string

Type implements PFlag's Value interface to return type name.

func (*OutputFormat) UnmarshalJSON ¶

func (i *OutputFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for OutputFormat

func (*OutputFormat) UnmarshalYAML ¶

func (i *OutputFormat) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements a YAML Unmarshaler for OutputFormat

type PrintableProto ¶

type PrintableProto struct {
	proto.Message
}

func (PrintableProto) MarshalJSON ¶

func (p PrintableProto) MarshalJSON() ([]byte, error)

type Printer ¶

type Printer struct{}

func (Printer) JSONToTable ¶

func (p Printer) JSONToTable(w io.Writer, jsonRows []byte, columns []Column) error

func (Printer) Print ¶

func (p Printer) Print(format OutputFormat, columns []Column, messages ...proto.Message) error

func (Printer) PrintInterface ¶ added in v0.2.13

func (p Printer) PrintInterface(format OutputFormat, columns []Column, v interface{}) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL