flags

Documentation

Index

• type APIPath
• type APITarget
• type AddPluginRepoArgs
• type AppDomain
• type AppInstance
• type AppName
• type AppRenameArgs
• type Authentication
• type BindSecurityGroupArgs
• type BindServiceArgs
• type Buildpack
• type CommandName
• type CopySourceArgs
• type CreateBuildpackArgs
• type CreateServiceArgs
• type DeleteServiceAuthTokenArgs
• type Domain
• type Feature
• type FilesArgs
• type HostDomain
• type InstallPluginArgs
• type MemoryWithUnlimited
  • func (m *MemoryWithUnlimited) UnmarshalFlag(val string) error
• type MigrateServiceInstancesArgs
• type OrgDomain
• type OrgSpace
• type Organization
• type ParamsAsJSON
• type PluginName
• type PluginRepoName
• type Quota
• type RenameBuildpackArgs
• type RenameOrgArgs
• type RenameServiceArgs
• type RenameServiceBrokerArgs
• type RenameSpaceArgs
• type RouteServiceArgs
• type SecurityGroup
• type SecurityGroupArgs
• type Service
• type ServiceAuthTokenArgs
• type ServiceBroker
• type ServiceBrokerArgs
• type ServiceInstance
• type ServiceInstanceKey
• type SetEnvironmentArgs
• type SetHealthCheckArgs
• type SetOrgQuotaArgs
• type SetOrgRoleArgs
• type SetSpaceQuotaArgs
• type SetSpaceRoleArgs
• type Space
• type SpaceDomain
• type SpaceQuota
• type StackName
• type UnbindSecurityGroupArgs
• type UnsetEnvironmentArgs
• type Username

Types

type APIPath

type APIPath struct {
	Path string `positional-arg-name:"PATH" required:"true" description:"The API endpoint"`
}

type APITarget

type APITarget struct {
	URL string `positional-arg-name:"URL" description:"API URL to target"`
}

type AddPluginRepoArgs

type AddPluginRepoArgs struct {
	PluginRepoName string `positional-arg-name:"REPO_NAME" required:"true" description:"The plugin repo name"`
	PluginRepoURL  string `positional-arg-name:"URL" required:"true" description:"The URL to the plugin repo"`
}

type AppDomain

type AppDomain struct {
	App    string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
}

type AppInstance

type AppInstance struct {
	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
	Index   int    `positional-arg-name:"INDEX" required:"true" description:"The index of the application instance"`
}

type AppName

type AppName struct {
	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
}

type AppRenameArgs

type AppRenameArgs struct {
	OldAppName string `positional-arg-name:"APP_NAME" required:"true" description:"The old application name"`
	NewAppName string `positional-arg-name:"NEW_APP_NAME" required:"true" description:"The new application name"`
}

type Authentication

type Authentication struct {
	Username string `positional-arg-name:"USERNAME" required:"true" description:"The username"`
	Password string `positional-arg-name:"PASSWORD" required:"true" description:"The password"`
}

type BindSecurityGroupArgs

type BindSecurityGroupArgs struct {
	SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"`
	OrganizationName  string `positional-arg-name:"ORG" required:"true" description:"The organization group name"`
	SpaceName         string `positional-arg-name:"SPACE" description:"The space name"`
}

type BindServiceArgs

type BindServiceArgs struct {
	AppName         string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
}

type Buildpack

type Buildpack struct {
	Buildpack string `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"`
}

type CommandName

type CommandName struct {
	CommandName string `positional-arg-name:"COMMAND_NAME" description:"The command name"`
}

type CopySourceArgs

type CopySourceArgs struct {
	SourceAppName string `positional-arg-name:"SOURCE-APP" required:"true" description:"The old application name"`
	TargetAppName string `positional-arg-name:"TARGET-NAME" required:"true" description:"The new application name"`
}

type CreateBuildpackArgs

type CreateBuildpackArgs struct {
	Buildpack string `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"`
	Path      string `positional-arg-name:"PATH" required:"true" description:"The path to the buildpack file"`
	Position  string `positional-arg-name:"POSITION" required:"true" description:"The position that sets priority"`
}

type CreateServiceArgs

type CreateServiceArgs struct {
	ServiceOffering string `positional-arg-name:"SERVICE" required:"true" description:"The service offering"`
	ServicePlan     string `positional-arg-name:"SERVICE_PLAN" required:"true" description:"The service plan that the service instance will use"`
	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
}

type DeleteServiceAuthTokenArgs

type DeleteServiceAuthTokenArgs struct {
	Label    string `positional-arg-name:"LABEL" required:"true" description:"The token label"`
	Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"`
}

type Domain

type Domain struct {
	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
}

type Feature

type Feature struct {
	Feature string `positional-arg-name:"FEATURE_NAME" required:"true" description:"The feature flag name"`
}

type FilesArgs

type FilesArgs struct {
	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
	Path    string `positional-arg-name:"PATH" description:"The file path"`
}

type HostDomain

type HostDomain struct {
	Host   string `positional-arg-name:"HOST" required:"true" description:"The hostname"`
	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
}

type InstallPluginArgs

type InstallPluginArgs struct {
	LocalPath string `positional-arg-name:"LOCAL_PATH/TO/PLUGIN" description:"The local path to the plugin, if the plugin exists locally"`
	URL       string `positional-arg-name:"URL" description:"The URL to the plugin, if the plugin exists online"`
}

type MemoryWithUnlimited

type MemoryWithUnlimited int64

func (*MemoryWithUnlimited) UnmarshalFlag

func (m *MemoryWithUnlimited) UnmarshalFlag(val string) error

TODO:Code for this flag exists in cf/formatters/bytes.go, move tests from there to here

type MigrateServiceInstancesArgs

type MigrateServiceInstancesArgs struct {
	V1Service  string `positional-arg-name:"v1_SERVICE" required:"true" description:"The old service offering"`
	V1Provider string `positional-arg-name:"v1_PROVIDER" required:"true" description:"The old service provider"`
	V1Plan     string `positional-arg-name:"v1_PLAN" required:"true" description:"The old service plan"`
	V2Service  string `positional-arg-name:"v2_SERVICE" required:"true" description:"The new service offering"`
	V2Plan     string `positional-arg-name:"v2_PLAN" required:"true" description:"The new service plan"`
}

type OrgDomain

type OrgDomain struct {
	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
	Domain       string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
}

type OrgSpace

type OrgSpace struct {
	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
	Space        string `positional-arg-name:"SPACE" required:"true" description:"The space"`
}

type Organization

type Organization struct {
	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
}

type ParamsAsJSON

type ParamsAsJSON struct {
	JSON string `positional-arg-name:"JSON" required:"true" description:"Parameters as JSON"`
}

type PluginName

type PluginName struct {
	PluginName string `positional-arg-name:"PLUGIN_NAME" required:"true" description:"The plugin name"`
}

type PluginRepoName

type PluginRepoName struct {
	PluginRepoName string `positional-arg-name:"REPO_NAME" required:"true" description:"The plugin repo name"`
}

type Quota

type Quota struct {
	Quota string `positional-arg-name:"QUOTA" required:"true" description:"The organization quota"`
}

type RenameBuildpackArgs

type RenameBuildpackArgs struct {
	OldBuildpackName string `positional-arg-name:"BUILDPACK_NAME" required:"true" description:"The old buildpack name"`
	NewBuildpackName string `positional-arg-name:"NEW_BUILDPACK_NAME" required:"true" description:"The new buildpack name"`
}

type RenameOrgArgs

type RenameOrgArgs struct {
	OldOrgName string `positional-arg-name:"ORG" required:"true" description:"The old organization name"`
	NewOrgName string `positional-arg-name:"NEW_ORG" required:"true" description:"The new organization name"`
}

type RenameServiceArgs

type RenameServiceArgs struct {
	ServiceInstance        string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance to rename"`
	NewServiceInstanceName string `positional-arg-name:"NEW_SERVICE_INSTANCE" required:"true" description:"The new name of the service instance"`
}

type RenameServiceBrokerArgs

type RenameServiceBrokerArgs struct {
	OldServiceBrokerName string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The old service broker name"`
	NewServiceBrokerName string `positional-arg-name:"NEW_SERVICE_BROKER" required:"true" description:"The new service broker name"`
}

type RenameSpaceArgs

type RenameSpaceArgs struct {
	OldSpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The old space name"`
	NewSpaceName string `positional-arg-name:"NEW_SPACE_NAME" required:"true" description:"The new space name"`
}

type RouteServiceArgs

type RouteServiceArgs struct {
	Domain          string `positional-arg-name:"DOMAIN" required:"true" description:"The domain of the route"`
	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
}

type SecurityGroup

type SecurityGroup struct {
	ServiceGroup string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group"`
}

type SecurityGroupArgs

type SecurityGroupArgs struct {
	SecurityGroup   string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group"`
	PathToJsonRules string `` /* 128-byte string literal not displayed */
}

type Service

type Service struct {
	Service string `positional-arg-name:"SERVICE" required:"true" description:"The service offering name"`
}

type ServiceAuthTokenArgs

type ServiceAuthTokenArgs struct {
	Label    string `positional-arg-name:"LABEL" required:"true" description:"The token label"`
	Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"`
	Token    string `positional-arg-name:"TOKEN" required:"true" description:"The token"`
}

type ServiceBroker

type ServiceBroker struct {
	ServiceBroker string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The service broker"`
}

type ServiceBrokerArgs

type ServiceBrokerArgs struct {
	ServiceBroker string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The service broker name"`
	Username      string `positional-arg-name:"USERNAME" required:"true" description:"The username"`
	Password      string `positional-arg-name:"PASSWORD" required:"true" description:"The password"`
	URL           string `positional-arg-name:"URL" required:"true" description:"The URL of the service broker"`
}

type ServiceInstance

type ServiceInstance struct {
	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance name"`
}

type ServiceInstanceKey

type ServiceInstanceKey struct {
	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
	ServiceKey      string `positional-arg-name:"SERVICE_KEY" required:"true" description:"The service key"`
}

type SetEnvironmentArgs

type SetEnvironmentArgs struct {
	AppName                  string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
	EnvironmentVariableName  string `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"`
	EnvironmentVariableValue string `positional-arg-name:"ENV_VAR_VALUE" required:"true" description:"The environment variable value"`
}

type SetHealthCheckArgs

type SetHealthCheckArgs struct {
	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
	Port    string `positional:"PORT" description:"Set to port"`
	None    string `positional:"NONE" description:"Set to none"`
}

type SetOrgQuotaArgs

type SetOrgQuotaArgs struct {
	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
	Quota        string `positional-arg-name:"QUOTA" required:"true" description:"The quota"`
}

type SetOrgRoleArgs

type SetOrgRoleArgs struct {
	Username     string `positional-arg-name:"USERNAME" required:"true" description:"The user"`
	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
	Role         string `positional-arg-name:"ROLE" required:"true" description:"The organization role"`
}

type SetSpaceQuotaArgs

type SetSpaceQuotaArgs struct {
	Space      string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space"`
	SpaceQuota string `positional-arg-name:"SPACE_QUOTA" required:"true" description:"The space quota"`
}

type SetSpaceRoleArgs

type SetSpaceRoleArgs struct {
	Username     string `positional-arg-name:"USERNAME" required:"true" description:"The user"`
	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
	Space        string `positional-arg-name:"ORG" required:"true" description:"The space"`
	Role         string `positional-arg-name:"ROLE" required:"true" description:"The space role"`
}

type Space

type Space struct {
	Space string `positional-arg-name:"SPACE" required:"true" description:"The space"`
}

type SpaceDomain

type SpaceDomain struct {
	Space  string `positional-arg-name:"SPACE" required:"true" description:"The space"`
	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
}

type SpaceQuota

type SpaceQuota struct {
	SpaceQuota string `positional-arg-name:"SPACE_QUOTA_NAME" required:"true" description:"The space quota"`
}

type StackName

type StackName struct {
	StackName string `positional-arg-name:"STACK_NAME" required:"true" description:"The stack name"`
}

type UnbindSecurityGroupArgs

type UnbindSecurityGroupArgs struct {
	SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"`
	OrganizationName  string `positional-arg-name:"ORG" required:"true" description:"The organization group name"`
	SpaceName         string `positional-arg-name:"SPACE" required:"true" description:"The space name"`
}

type UnsetEnvironmentArgs

type UnsetEnvironmentArgs struct {
	AppName                 string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
	EnvironmentVariableName string `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"`
}

type Username

type Username struct {
	Username string `positional-arg-name:"USERNAME" required:"true" description:"The username"`
}