 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
      Overview ¶
Package flag should not be imported by external consumers. It was not designed for external use.
Index ¶
- Constants
- func ParseStringToInt(str string) (int, error)
- type APIPath
- type APITarget
- type AddNetworkPolicyArgs
- type AddPluginRepoArgs
- type AppDomain
- type AppInstance
- type AppName
- type AppRenameArgs
- type AppType
- type Authentication
- type BindSecurityGroupArgs
- type BindServiceArgs
- type BindingName
- type Buildpack
- type BuildpackName
- type Color
- type Command
- type CommandName
- type CopySourceArgs
- type CreateBuildpackArgs
- type CreateServiceArgs
- type CreateUser
- type DeleteServiceAuthTokenArgs
- type DockerImage
- type Domain
- type Droplet
- type EnvironmentArgs
- type EnvironmentVariable
- type Feature
- type FilesArgs
- type HealthCheckType
- type HostDomain
- type InstallPluginArgs
- type Instances
- type IsolationSegmentName
- type JSONOrFileWithValidation
- type Locale
- type Megabytes
- type MemoryWithUnlimited
- type MigrateServiceInstancesArgs
- type NetworkPort
- type NetworkProtocol
- type OptionalAppName
- type OrgDomain
- type OrgIsolationArgs
- type OrgRole
- type OrgSpace
- type Organization
- type ParamsAsJSON
- type Path
- type PathWithAt
- type PathWithBool
- type PathWithExistenceCheck
- type PathWithExistenceCheckOrURL
- type PluginName
- type PluginRepoName
- type Port
- type PositiveInteger
- type Quota
- type RemoveNetworkPolicyArgs
- type RenameBuildpackArgs
- type RenameOrgArgs
- type RenameServiceArgs
- type RenameServiceBrokerArgs
- type RenameSpaceArgs
- type ResetOrgDefaultIsolationArgs
- type ResetSpaceIsolationArgs
- type RoutePath
- type RouteServiceArgs
- type RunTaskArgs
- type SSHPortForwarding
- type SecurityGroup
- type SecurityGroupArgs
- type SecurityGroupLifecycle
- 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 SpaceIsolationArgs
- type SpaceQuota
- type SpaceRole
- type StackName
- type TerminateTaskArgs
- type UnbindSecurityGroupArgs
- type UnsetEnvironmentArgs
- type Username
Constants ¶
      View Source
      
  
    const (
	ALLOWED_UNITS = "mg"
)
    
      View Source
      
  
    const DefaultLocalAddress = "localhost"
    
      View Source
      
  const WorkAroundPrefix = "\U000026f3"
    WorkAroundPrefix is the flag in hole emoji
Variables ¶
This section is empty.
Functions ¶
func ParseStringToInt ¶
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 AddNetworkPolicyArgs ¶
type AddNetworkPolicyArgs struct {
	SourceApp string `positional-arg-name:"SOURCE_APP" required:"true" description:"The source app"`
}
    type AddPluginRepoArgs ¶
type AppInstance ¶
type AppName ¶
type AppName struct {
	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
}
    type AppRenameArgs ¶
type Authentication ¶
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 BindingName ¶
type BindingName struct {
	Value string
}
    func (*BindingName) UnmarshalFlag ¶
func (b *BindingName) UnmarshalFlag(val string) error
type BuildpackName ¶
type BuildpackName 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 CreateBuildpackArgs ¶
type CreateBuildpackArgs struct {
	Buildpack string                      `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"`
	Path      PathWithExistenceCheckOrURL `positional-arg-name:"PATH" required:"true" description:"The path to the buildpack file"`
	Position  int                         `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 CreateUser ¶
type DockerImage ¶
type DockerImage struct {
	Path string
}
    func (*DockerImage) UnmarshalFlag ¶
func (d *DockerImage) UnmarshalFlag(val string) error
type Domain ¶
type Domain struct {
	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
}
    type EnvironmentArgs ¶
type EnvironmentArgs struct {
	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
}
    type EnvironmentVariable ¶
type EnvironmentVariable string
func (EnvironmentVariable) Complete ¶
func (EnvironmentVariable) Complete(prefix string) []flags.Completion
func (*EnvironmentVariable) UnmarshalFlag ¶
func (e *EnvironmentVariable) UnmarshalFlag(val string) error
type Feature ¶
type Feature struct {
	Feature string `positional-arg-name:"FEATURE_NAME" required:"true" description:"The feature flag name"`
}
    type HealthCheckType ¶
type HealthCheckType struct {
	Type string
}
    func (HealthCheckType) Complete ¶
func (HealthCheckType) Complete(prefix string) []flags.Completion
func (*HealthCheckType) UnmarshalFlag ¶
func (h *HealthCheckType) UnmarshalFlag(val string) error
type HostDomain ¶
type InstallPluginArgs ¶
type InstallPluginArgs struct {
	PluginNameOrLocation Path `` /* 230-byte string literal not displayed */
}
    type Instances ¶
func (*Instances) UnmarshalFlag ¶
type IsolationSegmentName ¶
type IsolationSegmentName struct {
	IsolationSegmentName string `positional-arg-name:"SEGMENT_NAME" required:"true" description:"The isolation segment name"`
}
    type JSONOrFileWithValidation ¶
type JSONOrFileWithValidation map[string]interface{}
func (JSONOrFileWithValidation) Complete ¶
func (JSONOrFileWithValidation) Complete(prefix string) []flags.Completion
func (*JSONOrFileWithValidation) UnmarshalFlag ¶
func (p *JSONOrFileWithValidation) UnmarshalFlag(pathOrJSON string) error
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 NetworkPort ¶
func (*NetworkPort) UnmarshalFlag ¶
func (np *NetworkPort) UnmarshalFlag(val string) error
type NetworkProtocol ¶
type NetworkProtocol struct {
	Protocol string
}
    func (NetworkProtocol) Complete ¶
func (NetworkProtocol) Complete(prefix string) []flags.Completion
func (*NetworkProtocol) UnmarshalFlag ¶
func (h *NetworkProtocol) UnmarshalFlag(val string) error
type OptionalAppName ¶
type OptionalAppName struct {
	AppName string `positional-arg-name:"APP_NAME" description:"The application name"`
}
    type OrgIsolationArgs ¶
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 PathWithAt ¶
type PathWithAt string
func (PathWithAt) Complete ¶
func (PathWithAt) Complete(prefix string) []flags.Completion
type PathWithBool ¶
type PathWithBool string
func (PathWithBool) Complete ¶
func (PathWithBool) Complete(prefix string) []flags.Completion
type PathWithExistenceCheck ¶
type PathWithExistenceCheck string
func (PathWithExistenceCheck) Complete ¶
func (PathWithExistenceCheck) Complete(prefix string) []flags.Completion
func (*PathWithExistenceCheck) UnmarshalFlag ¶
func (p *PathWithExistenceCheck) UnmarshalFlag(path string) error
type PathWithExistenceCheckOrURL ¶
type PathWithExistenceCheckOrURL string
func (PathWithExistenceCheckOrURL) Complete ¶
func (PathWithExistenceCheckOrURL) Complete(prefix string) []flags.Completion
func (*PathWithExistenceCheckOrURL) UnmarshalFlag ¶
func (p *PathWithExistenceCheckOrURL) UnmarshalFlag(path string) error
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 Port ¶
func (*Port) UnmarshalFlag ¶
type PositiveInteger ¶
type PositiveInteger struct {
	Value int
}
    func (*PositiveInteger) UnmarshalFlag ¶
func (posInt *PositiveInteger) UnmarshalFlag(rawValue string) error
type Quota ¶
type Quota struct {
	Quota string `positional-arg-name:"QUOTA" required:"true" description:"The organization quota"`
}
    type RemoveNetworkPolicyArgs ¶
type RemoveNetworkPolicyArgs struct {
	SourceApp string
}
    type RenameBuildpackArgs ¶
type RenameOrgArgs ¶
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 RenameSpaceArgs ¶
type ResetOrgDefaultIsolationArgs ¶
type ResetOrgDefaultIsolationArgs struct {
	OrgName string `positional-arg-name:"ORG_NAME" required:"true" description:"The organization name"`
}
    type ResetSpaceIsolationArgs ¶
type ResetSpaceIsolationArgs struct {
	SpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space name"`
}
    type RouteServiceArgs ¶
type RunTaskArgs ¶
type SSHPortForwarding ¶
func (*SSHPortForwarding) UnmarshalFlag ¶
func (s *SSHPortForwarding) UnmarshalFlag(val string) error
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 PathWithExistenceCheck `` /* 128-byte string literal not displayed */
}
    type SecurityGroupLifecycle ¶
type SecurityGroupLifecycle string
func (SecurityGroupLifecycle) Complete ¶
func (SecurityGroupLifecycle) Complete(prefix string) []flags.Completion
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 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 EnvironmentVariable `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"`
	HealthCheck HealthCheckType `positional-arg-name:"HEALTH_CHECK_TYPE" required:"true" description:"Set to 'port' or 'none'"`
}
    type SetOrgQuotaArgs ¶
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         OrgRole `positional-arg-name:"ROLE" required:"true" description:"The organization role"`
}
    type SetSpaceQuotaArgs ¶
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:"SPACE" required:"true" description:"The space"`
	Role         SpaceRole `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 SpaceIsolationArgs ¶
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 TerminateTaskArgs ¶
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" description:"The organization group name"`
	SpaceName         string `positional-arg-name:"SPACE" description:"The space name"`
}
    type UnsetEnvironmentArgs ¶
       Source Files
      ¶
      Source Files
      ¶
    
- app_type.go
- arguments.go
- binding_name.go
- buildpack.go
- color.go
- command.go
- completions.go
- docker.go
- droplet.go
- environment_variable.go
- godoc.go
- health_check_type.go
- instances.go
- locale.go
- megabytes.go
- memory_with_unlimited.go
- network_port.go
- network_protocol.go
- org_role.go
- parse.go
- path.go
- port.go
- positive_integer.go
- route_path.go
- security_group_lifecycle.go
- space_role.go
- ssh_port_forwarding.go
 Click to show internal directories. 
   Click to hide internal directories.