cli

Documentation

Index

• Variables
• func CmdValidator(t *testing.T, subject *cobra.Command, nSubCommands int, flags []string)
• func DeploymentStatus(baseURL, projectID string) string
• func GenerateAliases(use string, extra ...string) []string
• type DeleteOpts
  • func NewDeleteOpts(successMsg, failMsg string) *DeleteOpts
  • func (opts *DeleteOpts) Delete(d interface{}, a ...string) error
  • func (opts *DeleteOpts) FailMessage() string
  • func (opts *DeleteOpts) Prompt() error
  • func (opts *DeleteOpts) SuccessMessage() string
• type DownloaderOpts
  • func (opts *DownloaderOpts) NewWriteCloser() (io.WriteCloser, error)
  • func (opts *DownloaderOpts) OnError(f io.Closer) error
• type GlobalOpts
  • func (opts *GlobalOpts) ConfigOrgID() string
  • func (opts *GlobalOpts) ConfigProjectID() string
  • func (opts *GlobalOpts) PreRunE(cbs ...cmdOpt) error
  • func (opts *GlobalOpts) ValidateOrgID() error
  • func (opts *GlobalOpts) ValidateProjectID() error
• type ListOpts
  • func (opts *ListOpts) NewListOptions() *mongodbatlas.ListOptions
• type MetricsOpts
  • func (opts *MetricsOpts) NewProcessMetricsListOptions() *atlas.ProcessMeasurementListOptions
• type OutputOpts
  • func (opts *OutputOpts) ConfigOutput() string
  • func (opts *OutputOpts) ConfigWriter() io.Writer
  • func (opts *OutputOpts) InitOutput(w io.Writer, t string) func() error
  • func (opts *OutputOpts) IsCygwinTerminal() bool
  • func (opts *OutputOpts) IsTerminal() bool
  • func (opts *OutputOpts) Print(v interface{}) error
• type PerformanceAdvisorOpts
  • func (opts *PerformanceAdvisorOpts) Host() (string, error)
  • func (opts *PerformanceAdvisorOpts) MarkRequiredFlagsByService(cmd *cobra.Command) func() error
• type WatchOpts
  • func (opts *WatchOpts) Watch(f Watcher) error
• type Watcher

Variables

var ErrMissingOrgID = fmt.Errorf(requiredF, flag.OrgID)

Functions

func CmdValidator

func CmdValidator(t *testing.T, subject *cobra.Command, nSubCommands int, flags []string)

CmdValidator helps validate a cobra.Command, verifying the number of sub commands and the flags that are being defined for it

func DeploymentStatus

func DeploymentStatus(baseURL, projectID string) string

func GenerateAliases

func GenerateAliases(use string, extra ...string) []string

GenerateAliases return aliases for use such that they are: a version all lower case, a version with dashes, a singular versions with the same rules.

Types

type DeleteOpts

type DeleteOpts struct {
	Entry   string
	Confirm bool
	// contains filtered or unexported fields
}

DeleteOpts options required when deleting a resource. A command can compose this struct and then safely rely on the methods Prompt, or Delete to manage the interactions with the user

func NewDeleteOpts

func NewDeleteOpts(successMsg, failMsg string) *DeleteOpts

func (*DeleteOpts) Delete

func (opts *DeleteOpts) Delete(d interface{}, a ...string) error

Delete deletes a resource not associated to a project, it expects a callback that should perform the deletion from the store.

func (*DeleteOpts) FailMessage

func (opts *DeleteOpts) FailMessage() string

FailMessage gets the set fail message or the default value

func (*DeleteOpts) Prompt

func (opts *DeleteOpts) Prompt() error

Prompt confirms that the resource should be deleted

func (*DeleteOpts) SuccessMessage

func (opts *DeleteOpts) SuccessMessage() string

SuccessMessage gets the set success message or the default value

type DownloaderOpts

type DownloaderOpts struct {
	Out   string
	Force bool
	Fs    afero.Fs
}

DownloaderOpts options required when deleting a resource. A command can compose this struct and then safely rely on the methods Prompt, or Delete to manage the interactions with the user

func (*DownloaderOpts) NewWriteCloser

func (opts *DownloaderOpts) NewWriteCloser() (io.WriteCloser, error)

NewWriteCloser creates a new file, if Force is false then don't allow to overwrite the file

func (*DownloaderOpts) OnError

func (opts *DownloaderOpts) OnError(f io.Closer) error

type GlobalOpts

type GlobalOpts struct {
	OrgID     string
	ProjectID string
}

func (*GlobalOpts) ConfigOrgID

func (opts *GlobalOpts) ConfigOrgID() string

ConfigOrgID returns the organization id. If the id is empty, it caches it after querying config.

func (*GlobalOpts) ConfigProjectID

func (opts *GlobalOpts) ConfigProjectID() string

ConfigProjectID returns the project id. If the id is empty, it caches it after querying config.

func (*GlobalOpts) PreRunE

func (opts *GlobalOpts) PreRunE(cbs ...cmdOpt) error

PreRunE is a function to call before running the command, this will call any additional function pass as a callback

func (*GlobalOpts) ValidateOrgID

func (opts *GlobalOpts) ValidateOrgID() error

ValidateOrgID validates orgID

func (*GlobalOpts) ValidateProjectID

func (opts *GlobalOpts) ValidateProjectID() error

ValidateProjectID validates projectID

type ListOpts

type ListOpts struct {
	PageNum      int
	ItemsPerPage int
}

func (*ListOpts) NewListOptions

func (opts *ListOpts) NewListOptions() *mongodbatlas.ListOptions

type MetricsOpts

type MetricsOpts struct {
	ListOpts
	Granularity     string
	Period          string
	Start           string
	End             string
	MeasurementType []string
}

func (*MetricsOpts) NewProcessMetricsListOptions

func (opts *MetricsOpts) NewProcessMetricsListOptions() *atlas.ProcessMeasurementListOptions

type OutputOpts

type OutputOpts struct {
	Template  string
	OutWriter io.Writer
	Output    string
}

func (*OutputOpts) ConfigOutput

func (opts *OutputOpts) ConfigOutput() string

ConfigOutput returns the output format. If the format is empty, it caches it after querying config.

func (*OutputOpts) ConfigWriter

func (opts *OutputOpts) ConfigWriter() io.Writer

ConfigWriter returns the io.Writer. If the writer is nil, it defaults to os.Stdout and caches it.

func (*OutputOpts) InitOutput

func (opts *OutputOpts) InitOutput(w io.Writer, t string) func() error

InitOutput allow to init the OutputOpts in a functional way

func (*OutputOpts) IsCygwinTerminal

func (opts *OutputOpts) IsCygwinTerminal() bool

IsCygwinTerminal returns true is the current file descriptor is cygwin

func (*OutputOpts) IsTerminal

func (opts *OutputOpts) IsTerminal() bool

IsTerminal returns true is the current file descriptor is TTY kind of terminal

func (*OutputOpts) Print

func (opts *OutputOpts) Print(v interface{}) error

Print will evaluate the defined format and try to parse it accordingly outputting to the set writer

type PerformanceAdvisorOpts

type PerformanceAdvisorOpts struct {
	ProcessName string
	HostID      string
}

func (*PerformanceAdvisorOpts) Host

func (opts *PerformanceAdvisorOpts) Host() (string, error)

Host returns the correct processName or the hostId in accordance with the service

func (*PerformanceAdvisorOpts) MarkRequiredFlagsByService

func (opts *PerformanceAdvisorOpts) MarkRequiredFlagsByService(cmd *cobra.Command) func() error

MarkRequiredFlagsByService marks processName or hostId as required in accordance with the service

Atlas: processName is required

OM/CM: hostId is required

type WatchOpts

type WatchOpts struct {
	OutputOpts
	// contains filtered or unexported fields
}

func (*WatchOpts) Watch

func (opts *WatchOpts) Watch(f Watcher) error

InitOutput allow to init the OutputOpts in a functional way

type Watcher

type Watcher func() (bool, error)