command

package
v6.23.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2017 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source
const ExperimentalWarning = "This command is in EXPERIMENTAL stage and may change without notice"
View Source
const RedactedValue = "[PRIVATE DATA HIDDEN]"

Variables

This section is empty.

Functions

func CheckTarget

func CheckTarget(config Config, targetedOrganizationRequired bool, targetedSpaceRequired bool) error

CheckTarget confirms that the user is logged in. Optionally it will also check if an organization and space are targeted.

func MinimumAPIVersionCheck

func MinimumAPIVersionCheck(current string, minimum string) error

func SanitizeJSON

func SanitizeJSON(raw []byte) (map[string]interface{}, 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 {
	APIVersion() string
	AccessToken() 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, loggregator string, minCLIVersion string, doppler string, uaa string, routing string, skipSSLValidation bool)
	SetTokenInformation(accessToken string, refreshToken string, sshOAuthClient string)
	SkipSSLValidation() bool
	Target() string
	TargetedOrganization() configv3.Organization
	TargetedSpace() configv3.Space
	UAAOAuthClient() string
	UAAOAuthClientSecret() string
	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 (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 NoTargetedOrgError

type NoTargetedOrgError struct {
	BinaryName string
}

func (NoTargetedOrgError) Error

func (e NoTargetedOrgError) Error() string

func (NoTargetedOrgError) Translate

func (e NoTargetedOrgError) 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 RequestLoggerFileWriter

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

func NewRequestLoggerFileWriter

func NewRequestLoggerFileWriter(ui UI, filePaths []string) *RequestLoggerFileWriter

func (*RequestLoggerFileWriter) DisplayBody

func (display *RequestLoggerFileWriter) DisplayBody(_ []byte) error

func (*RequestLoggerFileWriter) DisplayHeader

func (display *RequestLoggerFileWriter) DisplayHeader(name string, value string) error

func (*RequestLoggerFileWriter) DisplayHost

func (display *RequestLoggerFileWriter) DisplayHost(name string) error

func (*RequestLoggerFileWriter) DisplayJSONBody

func (display *RequestLoggerFileWriter) DisplayJSONBody(body []byte) error

func (*RequestLoggerFileWriter) DisplayRequestHeader

func (display *RequestLoggerFileWriter) DisplayRequestHeader(method string, uri string, httpProtocol string) error

func (*RequestLoggerFileWriter) DisplayResponseHeader

func (display *RequestLoggerFileWriter) DisplayResponseHeader(httpProtocol string, status string) error

func (*RequestLoggerFileWriter) DisplayType

func (display *RequestLoggerFileWriter) DisplayType(name string, requestDate time.Time) error

func (*RequestLoggerFileWriter) HandleInternalError

func (display *RequestLoggerFileWriter) HandleInternalError(err error)

func (*RequestLoggerFileWriter) Start

func (display *RequestLoggerFileWriter) Start() error

func (*RequestLoggerFileWriter) Stop

func (display *RequestLoggerFileWriter) Stop() error

type RequestLoggerTerminalDisplay

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

func NewRequestLoggerTerminalDisplay

func NewRequestLoggerTerminalDisplay(ui UI) *RequestLoggerTerminalDisplay

func (*RequestLoggerTerminalDisplay) DisplayBody

func (display *RequestLoggerTerminalDisplay) DisplayBody(_ []byte) error

func (*RequestLoggerTerminalDisplay) DisplayHeader

func (display *RequestLoggerTerminalDisplay) DisplayHeader(name string, value string) error

func (*RequestLoggerTerminalDisplay) DisplayHost

func (display *RequestLoggerTerminalDisplay) DisplayHost(name string) error

func (*RequestLoggerTerminalDisplay) DisplayJSONBody

func (display *RequestLoggerTerminalDisplay) DisplayJSONBody(body []byte) error

func (*RequestLoggerTerminalDisplay) DisplayRequestHeader

func (display *RequestLoggerTerminalDisplay) DisplayRequestHeader(method string, uri string, httpProtocol string) error

func (*RequestLoggerTerminalDisplay) DisplayResponseHeader

func (display *RequestLoggerTerminalDisplay) DisplayResponseHeader(httpProtocol string, status string) error

func (*RequestLoggerTerminalDisplay) DisplayType

func (display *RequestLoggerTerminalDisplay) DisplayType(name string, requestDate time.Time) error

func (*RequestLoggerTerminalDisplay) HandleInternalError

func (display *RequestLoggerTerminalDisplay) HandleInternalError(err error)

func (*RequestLoggerTerminalDisplay) Start

func (display *RequestLoggerTerminalDisplay) Start() error

func (*RequestLoggerTerminalDisplay) Stop

func (display *RequestLoggerTerminalDisplay) Stop() error

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 (ServiceInstanceNotFoundError) Translate

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

type UI

type UI interface {
	DisplayBoolPrompt(prompt string, defaultResponse bool) (bool, error)
	DisplayError(err error)
	DisplayHeader(text string)
	DisplayNewline()
	DisplayOK()
	DisplayPair(attribute string, formattedString string, keys ...map[string]interface{})
	DisplayTable(prefix string, table [][]string, padding int) error
	DisplayText(template string, data ...map[string]interface{})
	DisplayTextWithFlavor(text string, keys ...map[string]interface{})
	DisplayWarning(formattedString string, keys ...map[string]interface{})
	DisplayWarnings(warnings []string)
	TranslateText(template string, data ...map[string]interface{}) string
}

UI is the interface to STDOUT

Directories

Path Synopsis
This file was generated by counterfeiter
This file was generated by counterfeiter
Package common should not be imported by external consumers.
Package common should not be imported by external consumers.
commonfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
Package flag should not be imported by external consumers.
Package flag should not be imported by external consumers.
v2
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
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
v3
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
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter

Jump to

Keyboard shortcuts

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