requirements

Documentation

Index

• func NewApplicationRequirement(name string, aR applications.Repository) *applicationAPIRequirement
• func NewBuildpackRequirement(name, stack string, bR api.BuildpackRepository) (req *buildpackAPIRequirement)
• func NewClientRequirement(clientID string, clientRepo api.ClientRepository) *userAPIRequirement
• func NewConfigRefreshingRequirement(requirement Requirement, configRefresher ConfigRefresher) configRefreshingRequirement
• func NewDomainRequirement(name string, config coreconfig.Reader, domainRepo api.DomainRepository) (req *domainAPIRequirement)
• func NewFactory(config coreconfig.ReadWriter, repoLocator api.RepositoryLocator) (factory apiRequirementFactory)
• func NewOrganizationRequirement(name string, sR organizations.OrganizationRepository) *organizationAPIRequirement
• func NewServiceInstanceRequirement(name string, sR api.ServiceRepository) (req *serviceInstanceAPIRequirement)
• func NewSpaceRequirement(name string, sR spaces.SpaceRepository) *spaceAPIRequirement
• func NewUserRequirement(username string, userRepo api.UserRepository, wantGUID bool) *userAPIRequirement
• type APIEndpointRequirement
  • func NewAPIEndpointRequirement(config coreconfig.Reader) APIEndpointRequirement
  • func (req APIEndpointRequirement) Execute() error
• type ApplicationRequirement
• type BuildpackRequirement
• type ConfigRefresher
• type DEAApplicationRequirement
  • func NewDEAApplicationRequirement(name string, applicationRepo applications.Repository) DEAApplicationRequirement
• type DomainRequirement
• type Factory
• type Failing
  • func (r Failing) Execute() error
• type LoginRequirement
  • func NewLoginRequirement(config coreconfig.Reader) LoginRequirement
  • func (req LoginRequirement) Execute() error
• type MaxAPIVersionRequirement
  • func NewMaxAPIVersionRequirement(config coreconfig.Reader, feature string, maximumVersion semver.Version) MaxAPIVersionRequirement
  • func (r MaxAPIVersionRequirement) Execute() error
• type MinAPIVersionRequirement
  • func NewMinAPIVersionRequirement(config coreconfig.Reader, feature string, requiredVersion semver.Version) MinAPIVersionRequirement
  • func (r MinAPIVersionRequirement) Execute() error
• type NumberArguments
  • func (r NumberArguments) Execute() error
• type NumberArgumentsError
  • func (e NumberArgumentsError) Error() string
• type OrganizationRequirement
• type Passing
  • func (r Passing) Execute() error
• type Requirement
  • func NewNumberArguments(passedArgs []string, expectedArgs []string) Requirement
  • func NewUsageRequirement(cmd Usable, errorMessage string, pred func() bool) Requirement
• type RequirementFunction
  • func (f RequirementFunction) Execute() error
• type Requirements
  • func (r Requirements) Execute() error
• type ServiceInstanceRequirement
• type SpaceRequirement
• type TargetedOrgRequirement
  • func NewTargetedOrgRequirement(config coreconfig.Reader) TargetedOrgRequirement
• type TargetedSpaceRequirement
  • func NewTargetedSpaceRequirement(config coreconfig.Reader) TargetedSpaceRequirement
  • func (req TargetedSpaceRequirement) Execute() error
• type UnsupportedLegacyFlagRequirement
  • func NewUnsupportedLegacyFlagRequirement(flags []string) UnsupportedLegacyFlagRequirement
  • func (r UnsupportedLegacyFlagRequirement) Execute() error
• type Usable
• type UserRequirement

Functions

func NewApplicationRequirement

func NewApplicationRequirement(name string, aR applications.Repository) *applicationAPIRequirement

func NewBuildpackRequirement

func NewBuildpackRequirement(name, stack string, bR api.BuildpackRepository) (req *buildpackAPIRequirement)

func NewClientRequirement

func NewClientRequirement(clientID string, clientRepo api.ClientRepository) *userAPIRequirement

func NewConfigRefreshingRequirement

func NewConfigRefreshingRequirement(requirement Requirement, configRefresher ConfigRefresher) configRefreshingRequirement

func NewDomainRequirement

func NewDomainRequirement(name string, config coreconfig.Reader, domainRepo api.DomainRepository) (req *domainAPIRequirement)

func NewFactory

func NewFactory(config coreconfig.ReadWriter, repoLocator api.RepositoryLocator) (factory apiRequirementFactory)

func NewOrganizationRequirement

func NewOrganizationRequirement(name string, sR organizations.OrganizationRepository) *organizationAPIRequirement

func NewServiceInstanceRequirement

func NewServiceInstanceRequirement(name string, sR api.ServiceRepository) (req *serviceInstanceAPIRequirement)

func NewSpaceRequirement

func NewSpaceRequirement(name string, sR spaces.SpaceRepository) *spaceAPIRequirement

func NewUserRequirement

func NewUserRequirement(
	username string,
	userRepo api.UserRepository,
	wantGUID bool,
) *userAPIRequirement

Types

type APIEndpointRequirement

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

func NewAPIEndpointRequirement

func NewAPIEndpointRequirement(config coreconfig.Reader) APIEndpointRequirement

func (APIEndpointRequirement) Execute

func (req APIEndpointRequirement) Execute() error

type ApplicationRequirement

type ApplicationRequirement interface {
	Requirement
	GetApplication() models.Application
}

type BuildpackRequirement

type BuildpackRequirement interface {
	Requirement
	GetBuildpack() models.Buildpack
}

type ConfigRefresher

type ConfigRefresher interface {
	Refresh() (coreconfig.Warning, error)
}

type DEAApplicationRequirement

type DEAApplicationRequirement interface {
	Requirement
	GetApplication() models.Application
}

func NewDEAApplicationRequirement

func NewDEAApplicationRequirement(name string, applicationRepo applications.Repository) DEAApplicationRequirement

type DomainRequirement

type DomainRequirement interface {
	Requirement
	GetDomain() models.DomainFields
}

type Factory

type Factory interface {
	NewApplicationRequirement(name string) ApplicationRequirement
	NewDEAApplicationRequirement(name string) DEAApplicationRequirement
	NewServiceInstanceRequirement(name string) ServiceInstanceRequirement
	NewLoginRequirement() Requirement
	NewSpaceRequirement(name string) SpaceRequirement
	NewTargetedSpaceRequirement() Requirement
	NewTargetedOrgRequirement() TargetedOrgRequirement
	NewOrganizationRequirement(name string) OrganizationRequirement
	NewDomainRequirement(name string) DomainRequirement
	NewUserRequirement(username string, wantGUID bool) UserRequirement
	NewClientRequirement(username string) UserRequirement
	NewBuildpackRequirement(buildpack, stack string) BuildpackRequirement
	NewAPIEndpointRequirement() Requirement
	NewMinAPIVersionRequirement(commandName string, requiredVersion semver.Version) Requirement
	NewMaxAPIVersionRequirement(commandName string, maximumVersion semver.Version) Requirement
	NewUnsupportedLegacyFlagRequirement(flags ...string) Requirement
	NewUsageRequirement(Usable, string, func() bool) Requirement
	NewNumberArguments([]string, ...string) Requirement
}

type Failing

type Failing struct {
	Message string
}

func (Failing) Execute

func (r Failing) Execute() error

type LoginRequirement

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

func NewLoginRequirement

func NewLoginRequirement(config coreconfig.Reader) LoginRequirement

func (LoginRequirement) Execute

func (req LoginRequirement) Execute() error

type MaxAPIVersionRequirement

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

func NewMaxAPIVersionRequirement

func NewMaxAPIVersionRequirement(
	config coreconfig.Reader,
	feature string,
	maximumVersion semver.Version,
) MaxAPIVersionRequirement

func (MaxAPIVersionRequirement) Execute

func (r MaxAPIVersionRequirement) Execute() error

type MinAPIVersionRequirement

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

func NewMinAPIVersionRequirement

func NewMinAPIVersionRequirement(
	config coreconfig.Reader,
	feature string,
	requiredVersion semver.Version,
) MinAPIVersionRequirement

func (MinAPIVersionRequirement) Execute

func (r MinAPIVersionRequirement) Execute() error

type NumberArguments

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

func (NumberArguments) Execute

func (r NumberArguments) Execute() error

type NumberArgumentsError

type NumberArgumentsError struct {
	ExpectedArgs []string
}

func (NumberArgumentsError) Error

func (e NumberArgumentsError) Error() string

type OrganizationRequirement

type OrganizationRequirement interface {
	Requirement
	SetOrganizationName(string)
	GetOrganization() models.Organization
}

type Passing

type Passing struct {
	Type string
}

func (Passing) Execute

func (r Passing) Execute() error

type Requirement

type Requirement interface {
	Execute() error
}

func NewNumberArguments

func NewNumberArguments(passedArgs []string, expectedArgs []string) Requirement

func NewUsageRequirement

func NewUsageRequirement(cmd Usable, errorMessage string, pred func() bool) Requirement

type RequirementFunction

type RequirementFunction func() error

func (RequirementFunction) Execute

func (f RequirementFunction) Execute() error

type Requirements

type Requirements []Requirement

func (Requirements) Execute

func (r Requirements) Execute() error

type ServiceInstanceRequirement

type ServiceInstanceRequirement interface {
	Requirement
	GetServiceInstance() models.ServiceInstance
}

type SpaceRequirement

type SpaceRequirement interface {
	Requirement
	SetSpaceName(string)
	GetSpace() models.Space
}

type TargetedOrgRequirement

type TargetedOrgRequirement interface {
	Requirement
	GetOrganizationFields() models.OrganizationFields
}

func NewTargetedOrgRequirement

func NewTargetedOrgRequirement(config coreconfig.Reader) TargetedOrgRequirement

type TargetedSpaceRequirement

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

func NewTargetedSpaceRequirement

func NewTargetedSpaceRequirement(config coreconfig.Reader) TargetedSpaceRequirement

func (TargetedSpaceRequirement) Execute

func (req TargetedSpaceRequirement) Execute() error

type UnsupportedLegacyFlagRequirement

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

func NewUnsupportedLegacyFlagRequirement

func NewUnsupportedLegacyFlagRequirement(flags []string) UnsupportedLegacyFlagRequirement

func (UnsupportedLegacyFlagRequirement) Execute

func (r UnsupportedLegacyFlagRequirement) Execute() error

type Usable

type Usable interface {
	Usage() string
}

type UserRequirement

type UserRequirement interface {
	Requirement
	GetUser() models.UserFields
}