cmdutil

package

v2.40.0 Latest Latest Go to latest Published: Apr 27, 2024 License: MIT Imports: 38 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/reubenmiller/go-c8y-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func BuildTemplatePath(namespace, name string) string
func DisableAuthCheck(cmd *cobra.Command) *cobra.Command
func DisableEncryptionCheck(cmd *cobra.Command) *cobra.Command
func ExecuteFileIterator(w io.Writer, log *logger.Logger, files []string, ...) error
func IsAuthCheckEnabled(cmd *cobra.Command) bool
func IsConfigEncryptionCheckEnabled(cmd *cobra.Command) bool
func NewRequestInputIterators(cmd *cobra.Command, cfg *config.Config) (*flags.RequestInputIterators, error)
func WithTemplateValue(factory *Factory) flags.GetOption
func WithViewCompletion(flagName string, dataviewFunc func() (*dataview.DataView, error)) completion.Option
type Browser
- func NewBrowser(launcher string, stdout, stderr io.Writer) Browser
type Factory
- func (f *Factory) CheckPostCommandError(err error) error
- func (f *Factory) CreateModeEnabled() error
- func (f *Factory) DeleteModeEnabled() error
- func (f *Factory) GetRequestHandler() (*request.RequestHandler, error)
- func (f *Factory) GetTenant() string
- func (f *Factory) GetViewProperties(cfg *config.Config, cmd *cobra.Command, output []byte) ([]string, error)
- func (f *Factory) ResolveTemplates(pattern string, withFullPath bool) ([]string, error)
- func (f *Factory) RunWithWorkers(client *c8y.Client, cmd *cobra.Command, req *c8y.RequestOptions, ...) error
- func (f *Factory) UpdateModeEnabled() error
- func (f *Factory) WithTemplateCompletion(flagName string) completion.Option
- func (f *Factory) WithTemplateFlag(cmd *cobra.Command) flags.Option
- func (f *Factory) WriteJSONToConsole(cfg *config.Config, cmd *cobra.Command, property string, output []byte) error
type FileIteratorOptions
type RandomRange
type TemplatePathResolver
- func NewTemplateResolver(factory *Factory) *TemplatePathResolver
- func (t *TemplatePathResolver) Resolve(name string) (string, error)
type TestBrowser
- func (b *TestBrowser) Browse(url string) error
- func (b *TestBrowser) BrowsedURL() string
- func (b *TestBrowser) Verify(t _testing, url string)

Constants ¶

This section is empty.

Variables ¶

View Source

var NamespaceSeparator = "::"

Functions ¶

func BuildTemplatePath ¶ added in v2.30.0

func BuildTemplatePath(namespace, name string) string

func DisableAuthCheck ¶

func DisableAuthCheck(cmd *cobra.Command) *cobra.Command

func DisableEncryptionCheck ¶

func DisableEncryptionCheck(cmd *cobra.Command) *cobra.Command

DisableEncryptionCheck disable encryption check when reading the configuration

func ExecuteFileIterator ¶ added in v2.33.0

func ExecuteFileIterator(w io.Writer, log *logger.Logger, files []string, iterFactory func(string) (iterator.Iterator, error), opt FileIteratorOptions) error

func IsAuthCheckEnabled ¶

func IsAuthCheckEnabled(cmd *cobra.Command) bool

func IsConfigEncryptionCheckEnabled ¶

func IsConfigEncryptionCheckEnabled(cmd *cobra.Command) bool

IsConfigEncryptionCheckEnabled check if the encryption in the configuration should be validated or not

func NewRequestInputIterators ¶

func NewRequestInputIterators(cmd *cobra.Command, cfg *config.Config) (*flags.RequestInputIterators, error)

NewRequestInputIterators create a request iterator based on pipe line configuration

func WithTemplateValue ¶

func WithTemplateValue(factory *Factory) flags.GetOption

WithTemplateValue get the template value using the path resolver controlled by the configuration

func WithViewCompletion ¶

func WithViewCompletion(flagName string, dataviewFunc func() (*dataview.DataView, error)) completion.Option

WithViewCompletion view completion

Types ¶

type Browser ¶

type Browser interface {
	Browse(string) error
}

func NewBrowser ¶

func NewBrowser(launcher string, stdout, stderr io.Writer) Browser

type Factory ¶

type Factory struct {
	IOStreams      *iostreams.IOStreams
	Browser        Browser
	Client         func() (*c8y.Client, error)
	Config         func() (*config.Config, error)
	Logger         func() (*logger.Logger, error)
	ActivityLogger func() (*activitylogger.ActivityLogger, error)
	Console        func() (*console.Console, error)
	DataView       func() (*dataview.DataView, error)

	BuildVersion string
	BuildBranch  string

	// Extension
	ExtensionManager func() extensions.ExtensionManager

	// Executable is the path to the currently invoked binary
	Executable string
}

func (*Factory) CheckPostCommandError ¶

func (f *Factory) CheckPostCommandError(err error) error

func (*Factory) CreateModeEnabled ¶

func (f *Factory) CreateModeEnabled() error

CreateModeEnabled create mode is enabled

func (*Factory) DeleteModeEnabled ¶

func (f *Factory) DeleteModeEnabled() error

ValidateDeleteMode delete mode is enabled

func (*Factory) GetRequestHandler ¶

func (f *Factory) GetRequestHandler() (*request.RequestHandler, error)

func (*Factory) GetTenant ¶ added in v2.30.0

func (f *Factory) GetTenant() string

func (*Factory) GetViewProperties ¶

func (f *Factory) GetViewProperties(cfg *config.Config, cmd *cobra.Command, output []byte) ([]string, error)

GetViewProperties Look up the view properties to display

func (*Factory) ResolveTemplates ¶ added in v2.30.0

func (f *Factory) ResolveTemplates(pattern string, withFullPath bool) ([]string, error)

func (*Factory) RunWithWorkers ¶

func (f *Factory) RunWithWorkers(client *c8y.Client, cmd *cobra.Command, req *c8y.RequestOptions, inputIterators *flags.RequestInputIterators) error

func (*Factory) UpdateModeEnabled ¶

func (f *Factory) UpdateModeEnabled() error

ValidateUpdateMode update mode is enabled

func (*Factory) WithTemplateCompletion ¶ added in v2.32.0

func (f *Factory) WithTemplateCompletion(flagName string) completion.Option

func (*Factory) WithTemplateFlag ¶

func (f *Factory) WithTemplateFlag(cmd *cobra.Command) flags.Option

WithTemplateFlag add template flag with completion

func (*Factory) WriteJSONToConsole ¶

func (f *Factory) WriteJSONToConsole(cfg *config.Config, cmd *cobra.Command, property string, output []byte) error

WriteJSONToConsole writes given json output to the console supporting the common options of select, output etc.

type FileIteratorOptions ¶ added in v2.33.0

type FileIteratorOptions struct {
	Infinite        bool
	FirstNRows      int64
	Times           RandomRange
	TotalRows       int64
	RandomSkip      float32
	DelayBefore     time.Duration
	Delay           time.Duration
	RandomDelayFunc flags.DurationGenerator
	OutputFunc      func([]byte) error
	Format          func([]byte, int64) []byte
}

type RandomRange ¶ added in v2.38.0

type RandomRange struct {
	Min *int64
	Max *int64
}

type TemplatePathResolver ¶

type TemplatePathResolver struct {
	Paths []string
}

func NewTemplateResolver ¶ added in v2.14.0

func NewTemplateResolver(factory *Factory) *TemplatePathResolver

func (*TemplatePathResolver) Resolve ¶

func (t *TemplatePathResolver) Resolve(name string) (string, error)

type TestBrowser ¶

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

func (*TestBrowser) Browse ¶

func (b *TestBrowser) Browse(url string) error

func (*TestBrowser) BrowsedURL ¶

func (b *TestBrowser) BrowsedURL() string

func (*TestBrowser) Verify ¶

func (b *TestBrowser) Verify(t _testing, url string)

Source Files ¶

View all Source files

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