cli

Documentation

Index

• Variables
• func DeploymentStatus(baseURL, projectID 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
• type ListOpts
  • func (opts *ListOpts) NewListOptions() *mongodbatlas.ListOptions
• type MetricsOpts
  • func (opts *MetricsOpts) NewProcessMetricsListOptions() *atlas.ProcessMeasurementListOptions

Variables

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

Functions

func DeploymentStatus

func DeploymentStatus(baseURL, projectID string) string

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
	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)

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 validate the project ID and call any additional function pass as a callback

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