Documentation
¶
Overview ¶
Package v2actions contains the business logic for the commands/v2 package
Index ¶
- type Actor
- func (_ Actor) CommandInfoByName(commandList interface{}, commandName string) (CommandInfo, error)
- func (_ Actor) CommandInfos(commandList interface{}) map[string]CommandInfo
- func (actor Actor) DeleteRoute(routeGUID string) (Warnings, error)
- func (actor Actor) GetApplicationByNameAndSpace(name string, spaceGUID string) (Application, Warnings, error)
- func (actor Actor) GetDomain(domainGUID string) (Domain, Warnings, error)
- func (actor Actor) GetOrphanedRoutesBySpace(spaceGUID string) ([]Route, Warnings, error)
- func (actor Actor) GetPrivateDomain(domainGUID string) (Domain, Warnings, error)
- func (actor Actor) GetRouteApplications(routeGUID string, query []ccv2.Query) ([]Application, Warnings, error)
- func (actor Actor) GetServiceBindingByApplicationAndServiceInstance(appGUID string, serviceInstanceGUID string) (ServiceBinding, Warnings, error)
- func (actor Actor) GetServiceInstanceByNameAndSpace(name string, spaceGUID string) (ServiceInstance, Warnings, error)
- func (actor Actor) GetSharedDomain(domainGUID string) (Domain, Warnings, error)
- func (actor Actor) GetSpaceRoutes(spaceGUID string, query []ccv2.Query) ([]Route, Warnings, error)
- func (actor Actor) GetSpaceServiceInstanceByName(spaceGUID string, name string) (ServiceInstance, Warnings, error)
- func (actor Actor) UnbindServiceBySpace(appName string, serviceInstanceName string, spaceGUID string) (Warnings, error)
- type Application
- type ApplicationNotFoundError
- type CloudControllerClient
- type CommandFlag
- type CommandInfo
- type Domain
- type DomainNotFoundError
- type EnvironmentVariable
- type ErrorInvalidCommand
- type OrphanedRoutesNotFoundError
- type Route
- type ServiceBinding
- type ServiceBindingNotFoundError
- type ServiceInstance
- type ServiceInstanceNotFoundError
- type Warnings
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Actor ¶
type Actor struct {
CloudControllerClient CloudControllerClient
}
func NewActor ¶
func NewActor(client CloudControllerClient) Actor
func (Actor) CommandInfoByName ¶
func (_ Actor) CommandInfoByName(commandList interface{}, commandName string) (CommandInfo, error)
CommandInfoByName returns the help information for a particular commandName in the commandList.
func (Actor) CommandInfos ¶
func (_ Actor) CommandInfos(commandList interface{}) map[string]CommandInfo
CommandInfos returns a slice of CommandInfo that only fills in the Name and Description for all the commands in commandList
func (Actor) DeleteRoute ¶
DeleteRoute deletes the Route associated with the provided Route GUID.
func (Actor) GetApplicationByNameAndSpace ¶
func (Actor) GetDomain ¶
GetDomain returns the shared or private domain associated with the provided Domain GUID.
func (Actor) GetOrphanedRoutesBySpace ¶
GetOrphanedRoutesBySpace returns a list of orphaned routes associated with the provided Space GUID.
func (Actor) GetPrivateDomain ¶
GetPrivateDomain returns the private domain associated with the provided Domain GUID.
func (Actor) GetRouteApplications ¶
func (actor Actor) GetRouteApplications(routeGUID string, query []ccv2.Query) ([]Application, Warnings, error)
GetRouteApplications returns a list of apps associated with the provided Route GUID
func (Actor) GetServiceBindingByApplicationAndServiceInstance ¶
func (Actor) GetServiceInstanceByNameAndSpace ¶
func (Actor) GetSharedDomain ¶
GetSharedDomain returns the shared domain associated with the provided Domain GUID.
func (Actor) GetSpaceRoutes ¶
GetSpaceRoutes returns a list of routes associated with the provided Space GUID
func (Actor) GetSpaceServiceInstanceByName ¶
type Application ¶
type Application ccv2.Application
type ApplicationNotFoundError ¶
type ApplicationNotFoundError struct {
Name string
}
func (ApplicationNotFoundError) Error ¶
func (e ApplicationNotFoundError) Error() string
type CloudControllerClient ¶
type CloudControllerClient interface {
DeleteRoute(routeGUID string) (ccv2.Warnings, error)
DeleteServiceBinding(serviceBindingGUID string) (ccv2.Warnings, error)
GetApplications(queries []ccv2.Query) ([]ccv2.Application, ccv2.Warnings, error)
GetPrivateDomain(domainGUID string) (ccv2.Domain, ccv2.Warnings, error)
GetRouteApplications(routeGUID string, queries []ccv2.Query) ([]ccv2.Application, ccv2.Warnings, error)
GetServiceBindings(queries []ccv2.Query) ([]ccv2.ServiceBinding, ccv2.Warnings, error)
GetServiceInstances(queries []ccv2.Query) ([]ccv2.ServiceInstance, ccv2.Warnings, error)
GetSpaceRoutes(spaceGUID string, queries []ccv2.Query) ([]ccv2.Route, ccv2.Warnings, error)
GetSpaceServiceInstances(spaceGUID string, includeUserProvidedServices bool, queries []ccv2.Query) ([]ccv2.ServiceInstance, ccv2.Warnings, error)
}
type CommandFlag ¶
type CommandFlag struct {
// Short is the short form of the flag
Short string
// Long is the long form of the flag
Long string
// Description is the description of the flag
Description string
}
CommandFlag contains the help details of a command's flag
type CommandInfo ¶
type CommandInfo struct {
// Name is the command name
Name string
// Description is the command description
Description string
// Alias is the command alias
Alias string
// Usage is the command usage string, may contain examples and flavor text
Usage string
// RelatedCommands is a list of commands related to the command
RelatedCommands []string
// Flags contains the list of flags for this command
Flags []CommandFlag
// Environment is a list of environment variables specific for this command
Environment []EnvironmentVariable
}
CommandInfo contains the help details of a command
type DomainNotFoundError ¶
type DomainNotFoundError struct{}
DomainNotFoundError is an error wrapper that represents the case when the domain is not found.
func (DomainNotFoundError) Error ¶
func (e DomainNotFoundError) Error() string
Error method to display the error message.
type EnvironmentVariable ¶
Environment contains env vars specific for this command
type ErrorInvalidCommand ¶
type ErrorInvalidCommand struct {
CommandName string
}
func (ErrorInvalidCommand) Error ¶
func (err ErrorInvalidCommand) Error() string
type OrphanedRoutesNotFoundError ¶
type OrphanedRoutesNotFoundError struct{}
OrphanedRoutesNotFoundError is an error wrapper that represents the case when no orphaned routes are found.
func (OrphanedRoutesNotFoundError) Error ¶
func (e OrphanedRoutesNotFoundError) Error() string
Error method to display the error message.
type ServiceBinding ¶
type ServiceBinding ccv2.ServiceBinding
type ServiceBindingNotFoundError ¶
func (ServiceBindingNotFoundError) Error ¶
func (e ServiceBindingNotFoundError) Error() string
type ServiceInstance ¶
type ServiceInstance ccv2.ServiceInstance
type ServiceInstanceNotFoundError ¶
type ServiceInstanceNotFoundError struct {
Name string
}
func (ServiceInstanceNotFoundError) Error ¶
func (e ServiceInstanceNotFoundError) Error() string
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
This file was generated by counterfeiter
|
This file was generated by counterfeiter |