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
- func WarnAPIVersionCheck(config Config, ui UI) error
- type APINotFoundError
- type APIRequestError
- type ApplicationNotFoundError
- type ArgumentCombinationError
- type BadCredentialsError
- type Config
- type ExtendedCommander
- type HealthCheckTypeUnsupportedError
- type InvalidSSLCertError
- type LifecycleMinimumAPIVersionNotMetError
- type MinimumAPIVersionNotMetError
- type NoAPISetError
- type NoOrganizationTargetedError
- type NoSpaceTargetedError
- type NotLoggedInError
- type ParseArgumentError
- type RequiredArgumentError
- type SSLCertErrorError
- type ServiceInstanceNotFoundError
- type SharedActor
- type ThreeRequiredArgumentsError
- type UI
- type UnsupportedURLSchemeError
Constants ¶
View Source
const (
MinVersionLifecyleStagingV2 = "2.68.0"
MinVersionHTTPEndpointHealthCheckV2 = "2.68.0"
MinVersionProcessHealthCheckV2 = "2.47.0"
MinVersionRunTaskV3 = "3.0.0"
MinVersionIsolationSegmentV3 = "3.11.0"
)
View Source
const ExperimentalWarning = "This command is in EXPERIMENTAL stage and may change without notice"
Variables ¶
This section is empty.
Functions ¶
func MinimumAPIVersionCheck ¶
func MinimumAPIVersionCheck(current string, minimum string) error
func WarnAPIVersionCheck ¶
func WarnAPIVersionCheck(config Config, ui UI) error
Types ¶
type APINotFoundError ¶
type APINotFoundError struct {
URL string
}
type APIRequestError ¶
type APIRequestError struct {
Err error
}
type ApplicationNotFoundError ¶
type ApplicationNotFoundError struct {
Name string
}
type ArgumentCombinationError ¶
type ArgumentCombinationError struct {
Arg1 string
Arg2 string
}
ArgumentCombinationError represent an error caused by using two command line arguments that cannot be used together.
type BadCredentialsError ¶
type BadCredentialsError struct{}
type Config ¶
type Config interface {
AccessToken() string
AddPlugin(configv3.Plugin)
AddPluginRepository(name string, url string)
APIVersion() string
BinaryName() string
BinaryVersion() string
ColorEnabled() configv3.ColorSetting
CurrentUser() (configv3.User, error)
DialTimeout() time.Duration
Experimental() bool
GetPlugin(pluginName string) (configv3.Plugin, bool)
GetPluginCaseInsensitive(pluginName string) (configv3.Plugin, bool)
HasTargetedOrganization() bool
HasTargetedSpace() bool
Locale() string
MinCLIVersion() string
OverallPollingTimeout() time.Duration
PluginHome() string
PluginRepositories() []configv3.PluginRepository
Plugins() []configv3.Plugin
PollingInterval() time.Duration
RefreshToken() string
RemovePlugin(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)
WritePluginConfig() error
}
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 HealthCheckTypeUnsupportedError ¶
type HealthCheckTypeUnsupportedError struct {
SupportedTypes []string
}
type InvalidSSLCertError ¶
type InvalidSSLCertError struct {
API string
}
type LifecycleMinimumAPIVersionNotMetError ¶
type LifecycleMinimumAPIVersionNotMetError struct {
CurrentVersion string
MinimumVersion string
}
type MinimumAPIVersionNotMetError ¶
type MinimumAPIVersionNotMetError struct {
CurrentVersion string
MinimumVersion string
}
type NoAPISetError ¶
type NoAPISetError struct {
BinaryName string
}
type NoOrganizationTargetedError ¶
type NoOrganizationTargetedError struct {
BinaryName string
}
type NoSpaceTargetedError ¶
type NoSpaceTargetedError struct {
BinaryName string
}
type NotLoggedInError ¶
type NotLoggedInError struct {
BinaryName string
}
type ParseArgumentError ¶
type ParseArgumentError struct {
ArgumentName string
ExpectedType string
}
type RequiredArgumentError ¶
type RequiredArgumentError struct {
ArgumentName string
}
type SSLCertErrorError ¶
type SSLCertErrorError struct {
Message string
}
type ServiceInstanceNotFoundError ¶
type ServiceInstanceNotFoundError struct {
Name string
}
type SharedActor ¶
type SharedActor interface {
CheckTarget(config sharedaction.Config, targetedOrganizationRequired bool, targetedSpaceRequired bool) error
}
type ThreeRequiredArgumentsError ¶
type ThreeRequiredArgumentsError struct {
ArgumentName1 string
ArgumentName2 string
ArgumentName3 string
}
type UI ¶
type UI interface {
DisplayBoolPrompt(defaultResponse bool, template string, templateValues ...map[string]interface{}) (bool, error)
DisplayChangesForPush(changeSet []ui.Change) error
DisplayError(err error)
DisplayHeader(text string)
DisplayInstancesTableForApp(table [][]string)
DisplayKeyValueTable(prefix string, table [][]string, padding int)
DisplayKeyValueTableForApp(table [][]string)
DisplayKeyValueTableForV3App(table [][]string, crashedProcesses []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{})
DisplayTextWithBold(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
Writer() io.Writer
}
UI is the interface to STDOUT
type UnsupportedURLSchemeError ¶
type UnsupportedURLSchemeError struct {
UnsupportedURL string
}
Source Files
¶
Directories
¶
Path | Synopsis |
---|---|
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Package common should not be imported by external consumers.
|
Package common should not be imported by external consumers. |
commonfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Package flag should not be imported by external consumers.
|
Package flag should not be imported by external consumers. |
Package plugin should not be imported by external consumers.
|
Package plugin should not be imported by external consumers. |
pluginfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
shared
Package shared should not be imported by external consumers.
|
Package shared should not be imported by external consumers. |
Package v2 should not be imported by external consumers.
|
Package v2 should not be imported by external consumers. |
shared
Package shared should not be imported by external consumers.
|
Package shared should not be imported by external consumers. |
v2fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Package v3 should not be imported by external consumers.
|
Package v3 should not be imported by external consumers. |
shared
Package shared should not be imported by external consumers.
|
Package shared should not be imported by external consumers. |
v3fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Click to show internal directories.
Click to hide internal directories.