command

Documentation

Overview

Package command should not be imported by external consumers. It was not designed for external use.

Index

• Constants
• func MinimumAPIVersionCheck(current string, minimum string) error
• type APINotFoundError
  • func (e APINotFoundError) Error() string
  • func (e APINotFoundError) Translate(translate func(string, ...interface{}) string) string
• type APIRequestError
  • func (e APIRequestError) Error() string
  • func (e APIRequestError) Translate(translate func(string, ...interface{}) string) string
• type ApplicationNotFoundError
  • func (e ApplicationNotFoundError) Error() string
  • func (e ApplicationNotFoundError) Translate(translate func(string, ...interface{}) string) string
• type Config
• type ExtendedCommander
• type InvalidSSLCertError
  • func (e InvalidSSLCertError) Error() string
  • func (e InvalidSSLCertError) Translate(translate func(string, ...interface{}) string) string
• type MinimumAPIVersionNotMetError
  • func (e MinimumAPIVersionNotMetError) Error() string
  • func (e MinimumAPIVersionNotMetError) Translate(translate func(string, ...interface{}) string) string
• type NoAPISetError
  • func (e NoAPISetError) Error() string
  • func (e NoAPISetError) Translate(translate func(string, ...interface{}) string) string
• type NoTargetedOrganizationError
  • func (e NoTargetedOrganizationError) Error() string
  • func (e NoTargetedOrganizationError) Translate(translate func(string, ...interface{}) string) string
• type NoTargetedSpaceError
  • func (e NoTargetedSpaceError) Error() string
  • func (e NoTargetedSpaceError) Translate(translate func(string, ...interface{}) string) string
• type NotLoggedInError
  • func (e NotLoggedInError) Error() string
  • func (e NotLoggedInError) Translate(translate func(string, ...interface{}) string) string
• type ParseArgumentError
  • func (e ParseArgumentError) Error() string
  • func (e ParseArgumentError) Translate(translate func(string, ...interface{}) string) string
• type RequiredArgumentError
  • func (e RequiredArgumentError) Error() string
  • func (e RequiredArgumentError) Translate(translate func(string, ...interface{}) string) string
• type SSLCertErrorError
  • func (e SSLCertErrorError) Error() string
  • func (e SSLCertErrorError) Translate(translate func(string, ...interface{}) string) string
• type ServiceInstanceNotFoundError
  • func (e ServiceInstanceNotFoundError) Error() string
  • func (e ServiceInstanceNotFoundError) Translate(translate func(string, ...interface{}) string) string
• type SharedActor
• type UI

Constants

const ExperimentalWarning = "This command is in EXPERIMENTAL stage and may change without notice"

Functions

func MinimumAPIVersionCheck

func MinimumAPIVersionCheck(current string, minimum string) error

Types

type APINotFoundError

type APINotFoundError struct {
	URL string
}

func (APINotFoundError) Error

func (e APINotFoundError) Error() string

func (APINotFoundError) Translate

func (e APINotFoundError) Translate(translate func(string, ...interface{}) string) string

type APIRequestError

type APIRequestError struct {
	Err error
}

func (APIRequestError) Error

func (e APIRequestError) Error() string

func (APIRequestError) Translate

func (e APIRequestError) Translate(translate func(string, ...interface{}) string) string

type ApplicationNotFoundError

type ApplicationNotFoundError struct {
	Name string
}

func (ApplicationNotFoundError) Error

func (e ApplicationNotFoundError) Error() string

func (ApplicationNotFoundError) Translate

func (e ApplicationNotFoundError) Translate(translate func(string, ...interface{}) string) string

type Config

type Config interface {
	AccessToken() string
	APIVersion() string
	BinaryName() string
	BinaryVersion() string
	ColorEnabled() configv3.ColorSetting
	CurrentUser() (configv3.User, error)
	DialTimeout() time.Duration
	Experimental() bool
	HasTargetedOrganization() bool
	HasTargetedSpace() bool
	Locale() string
	MinCLIVersion() string
	OverallPollingTimeout() time.Duration
	Plugins() map[string]configv3.Plugin
	PollingInterval() time.Duration
	RefreshToken() string
	SetAccessToken(token string)
	SetOrganizationInformation(guid string, name string)
	SetRefreshToken(token string)
	SetSpaceInformation(guid string, name string, allowSSH bool)
	SetTargetInformation(api string, apiVersion string, auth string, minCLIVersion string, doppler string, uaa string, routing string, skipSSLValidation bool)
	SetTokenInformation(accessToken string, refreshToken string, sshOAuthClient string)
	SkipSSLValidation() bool
	StagingTimeout() time.Duration
	StartupTimeout() time.Duration
	Target() string
	TargetedOrganization() configv3.Organization
	TargetedSpace() configv3.Space
	UAAOAuthClient() string
	UAAOAuthClientSecret() string
	UnsetOrganizationInformation()
	UnsetSpaceInformation()
	Verbose() (bool, []string)
}

Config a way of getting basic CF configuration

type ExtendedCommander

type ExtendedCommander interface {
	flags.Commander
	Setup(Config, UI) error
}

ExtendedCommander extends the go-flags Command interface by forcing a Setup function on all commands. This setup function should setup all command dependencies.

type InvalidSSLCertError

type InvalidSSLCertError struct {
	API string
}

func (InvalidSSLCertError) Error

func (e InvalidSSLCertError) Error() string

func (InvalidSSLCertError) Translate

func (e InvalidSSLCertError) Translate(translate func(string, ...interface{}) string) string

type MinimumAPIVersionNotMetError

type MinimumAPIVersionNotMetError struct {
	CurrentVersion string
	MinimumVersion string
}

func (MinimumAPIVersionNotMetError) Error

func (e MinimumAPIVersionNotMetError) Error() string

func (MinimumAPIVersionNotMetError) Translate

func (e MinimumAPIVersionNotMetError) Translate(translate func(string, ...interface{}) string) string

type NoAPISetError

type NoAPISetError struct {
	BinaryName string
}

func (NoAPISetError) Error

func (e NoAPISetError) Error() string

func (NoAPISetError) Translate

func (e NoAPISetError) Translate(translate func(string, ...interface{}) string) string

type NoTargetedOrganizationError

type NoTargetedOrganizationError struct {
	BinaryName string
}

func (NoTargetedOrganizationError) Error

func (e NoTargetedOrganizationError) Error() string

func (NoTargetedOrganizationError) Translate

func (e NoTargetedOrganizationError) Translate(translate func(string, ...interface{}) string) string

type NoTargetedSpaceError

type NoTargetedSpaceError struct {
	BinaryName string
}

func (NoTargetedSpaceError) Error

func (e NoTargetedSpaceError) Error() string

func (NoTargetedSpaceError) Translate

func (e NoTargetedSpaceError) Translate(translate func(string, ...interface{}) string) string

type NotLoggedInError

type NotLoggedInError struct {
	BinaryName string
}

func (NotLoggedInError) Error

func (e NotLoggedInError) Error() string

func (NotLoggedInError) Translate

func (e NotLoggedInError) Translate(translate func(string, ...interface{}) string) string

type ParseArgumentError

type ParseArgumentError struct {
	ArgumentName string
	ExpectedType string
}

func (ParseArgumentError) Error

func (e ParseArgumentError) Error() string

func (ParseArgumentError) Translate

func (e ParseArgumentError) Translate(translate func(string, ...interface{}) string) string

type RequiredArgumentError

type RequiredArgumentError struct {
	ArgumentName string
}

func (RequiredArgumentError) Error

func (e RequiredArgumentError) Error() string

func (RequiredArgumentError) Translate

func (e RequiredArgumentError) Translate(translate func(string, ...interface{}) string) string

type SSLCertErrorError

type SSLCertErrorError struct {
	Message string
}

func (SSLCertErrorError) Error

func (e SSLCertErrorError) Error() string

func (SSLCertErrorError) Translate

func (e SSLCertErrorError) Translate(translate func(string, ...interface{}) string) string

type ServiceInstanceNotFoundError

type ServiceInstanceNotFoundError struct {
	Name string
}

func (ServiceInstanceNotFoundError) Error

func (e ServiceInstanceNotFoundError) Error() string

func (ServiceInstanceNotFoundError) Translate

func (e ServiceInstanceNotFoundError) Translate(translate func(string, ...interface{}) string) string

type SharedActor

type SharedActor interface {
	CheckTarget(config sharedaction.Config, targetedOrganizationRequired bool, targetedSpaceRequired bool) error
}

type UI

type UI interface {
	DisplayBoolPrompt(defaultResponse bool, template string, templateValues ...map[string]interface{}) (bool, error)
	DisplayError(err error)
	DisplayHeader(text string)
	DisplayInstancesTableForApp(table [][]string)
	DisplayKeyValueTable(prefix string, table [][]string, padding int)
	DisplayKeyValueTableForApp(table [][]string)
	DisplayLogMessage(message ui.LogMessage, displayHeader bool)
	DisplayNewline()
	DisplayNonWrappingTable(prefix string, table [][]string, padding int)
	DisplayOK()
	DisplayTableWithHeader(prefix string, table [][]string, padding int)
	DisplayText(template string, data ...map[string]interface{})
	DisplayTextWithFlavor(text string, keys ...map[string]interface{})
	DisplayWarning(formattedString string, keys ...map[string]interface{})
	DisplayWarnings(warnings []string)
	RequestLoggerFileWriter(filePaths []string) *ui.RequestLoggerFileWriter
	RequestLoggerTerminalDisplay() *ui.RequestLoggerTerminalDisplay
	TranslateText(template string, data ...map[string]interface{}) string
	UserFriendlyDate(input time.Time) string
}

UI is the interface to STDOUT