Documentation
¶
Overview ¶
Package v2 should not be imported by external consumers. It was not designed for external use.
Index ¶
- Constants
- type APIActor
- type AllowSpaceSSHCommand
- type ApiCommand
- type AppActor
- type AppCommand
- type AppsCommand
- type AuthActor
- type AuthCommand
- type BindRouteServiceCommand
- type BindRunningSecurityGroupCommand
- type BindSecurityGroupActor
- type BindSecurityGroupCommand
- type BindServiceActor
- type BindServiceCommand
- type BindStagingSecurityGroupCommand
- type BuildpacksCommand
- type CheckRouteCommand
- type ConfigCommand
- type CopySourceCommand
- type CreateAppManifestActor
- type CreateAppManifestCommand
- type CreateBuildpackCommand
- type CreateDomainCommand
- type CreateOrgCommand
- type CreateQuotaCommand
- type CreateRouteActor
- type CreateRouteCommand
- type CreateSecurityGroupCommand
- type CreateServiceAuthTokenCommand
- type CreateServiceBrokerCommand
- type CreateServiceCommand
- type CreateServiceKeyCommand
- type CreateSharedDomainCommand
- type CreateSpaceCommand
- type CreateSpaceQuotaCommand
- type CreateUserActor
- type CreateUserCommand
- type CreateUserProvidedServiceCommand
- type CurlCommand
- type DeleteBuildpackCommand
- type DeleteCommand
- type DeleteDomainCommand
- type DeleteOrgCommand
- type DeleteOrganizationActor
- type DeleteOrphanedRoutesActor
- type DeleteOrphanedRoutesCommand
- type DeleteQuotaCommand
- type DeleteRouteCommand
- type DeleteSecurityGroupCommand
- type DeleteServiceAuthTokenCommand
- type DeleteServiceBrokerCommand
- type DeleteServiceCommand
- type DeleteServiceKeyCommand
- type DeleteSharedDomainCommand
- type DeleteSpaceActor
- type DeleteSpaceCommand
- type DeleteSpaceQuotaCommand
- type DeleteUserCommand
- type DisableFeatureFlagCommand
- type DisableSSHCommand
- type DisableServiceAccessCommand
- type DisallowSpaceSSHCommand
- type DomainsCommand
- type EnableFeatureFlagCommand
- type EnableSSHCommand
- type EnableServiceAccessCommand
- type EnvCommand
- type EventsCommand
- type FeatureFlagCommand
- type FeatureFlagsCommand
- type FilesCommand
- type GetHealthCheckActor
- type GetHealthCheckCommand
- type LoginCommand
- type LogoutCommand
- type LogsActor
- type LogsCommand
- type MapRouteCommand
- type MarketplaceCommand
- type MigrateServiceInstancesCommand
- type OauthTokenActor
- type OauthTokenCommand
- type OrgActor
- type OrgActorV3
- type OrgCommand
- type OrgUsersCommand
- type OrgsActor
- type OrgsCommand
- type PasswdCommand
- type ProgressBar
- type PurgeServiceInstanceCommand
- type PurgeServiceOfferingCommand
- type PushCommand
- type QuotaCommand
- type QuotasCommand
- type RenameBuildpackCommand
- type RenameCommand
- type RenameOrgCommand
- type RenameServiceBrokerCommand
- type RenameServiceCommand
- type RenameSpaceCommand
- type RestageActor
- type RestageCommand
- type RestartActor
- type RestartAppInstanceCommand
- type RestartCommand
- type RouterGroupsCommand
- type RoutesCommand
- type RunningEnvironmentVariableGroupCommand
- type RunningSecurityGroupsCommand
- type SSHCodeActor
- type SSHCodeCommand
- type SSHCommand
- type SSHEnabledCommand
- type ScaleCommand
- type SecurityGroupCommand
- type SecurityGroupsActor
- type SecurityGroupsCommand
- type ServiceAccessCommand
- type ServiceActor
- type ServiceAuthTokensCommand
- type ServiceBrokersCommand
- type ServiceCommand
- type ServiceKeyCommand
- type ServiceKeysCommand
- type ServicesCommand
- type SetEnvCommand
- type SetHealthCheckActor
- type SetHealthCheckCommand
- type SetOrgRoleCommand
- type SetQuotaCommand
- type SetRunningEnvironmentVariableGroupCommand
- type SetSpaceQuotaCommand
- type SetSpaceRoleCommand
- type SetStagingEnvironmentVariableGroupCommand
- type SharePrivateDomainCommand
- type SpaceActor
- type SpaceActorV3
- type SpaceCommand
- type SpaceQuotaCommand
- type SpaceQuotasCommand
- type SpaceSSHAllowedCommand
- type SpaceUsersCommand
- type SpacesActor
- type SpacesCommand
- type StackCommand
- type StacksCommand
- type StagingEnvironmentVariableGroupCommand
- type StagingSecurityGroupsCommand
- type StartActor
- type StartCommand
- type StopCommand
- type TargetActor
- type TargetCommand
- type UnbindRouteServiceCommand
- type UnbindRunningSecurityGroupCommand
- type UnbindSecurityGroupActor
- type UnbindSecurityGroupCommand
- type UnbindServiceActor
- type UnbindServiceCommand
- type UnbindStagingSecurityGroupCommand
- type UnmapRouteCommand
- type UnsetEnvCommand
- type UnsetOrgRoleCommand
- type UnsetSpaceQuotaCommand
- type UnsetSpaceRoleCommand
- type UnsharePrivateDomainCommand
- type UpdateBuildpackCommand
- type UpdateQuotaCommand
- type UpdateSecurityGroupCommand
- type UpdateServiceAuthTokenCommand
- type UpdateServiceBrokerCommand
- type UpdateServiceCommand
- type UpdateSpaceQuotaCommand
- type UpdateUserProvidedServiceCommand
- type V2PushActor
- type V2PushCommand
Constants ¶
View Source
const WorkAroundPrefix = "\U000026f3"
WorkAroundPrefix is the flag in hole emoji
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIActor ¶
type APIActor interface {
ClearTarget(config v2action.Config)
SetTarget(config v2action.Config, settings v2action.TargetSettings) (v2action.Warnings, error)
}
type AllowSpaceSSHCommand ¶
type AllowSpaceSSHCommand struct {
RequiredArgs flag.Space `positional-args:"yes"`
// contains filtered or unexported fields
}
type ApiCommand ¶
type ApiCommand struct {
OptionalArgs flag.APITarget `positional-args:"yes"`
SkipSSLValidation bool `long:"skip-ssl-validation" description:"Skip verification of the API endpoint. Not recommended!"`
Unset bool `long:"unset" description:"Remove all api endpoint targeting"`
UI command.UI
Actor APIActor
Config command.Config
// contains filtered or unexported fields
}
func (*ApiCommand) ClearTarget ¶
func (cmd *ApiCommand) ClearTarget() error
type AppActor ¶
type AppActor interface {
GetApplicationByNameAndSpace(name string, spaceGUID string) (v2action.Application, v2action.Warnings, error)
GetApplicationSummaryByNameAndSpace(name string, spaceGUID string) (v2action.ApplicationSummary, v2action.Warnings, error)
}
type AppCommand ¶
type AppCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
GUID bool `` /* 131-byte string literal not displayed */
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor AppActor
// contains filtered or unexported fields
}
type AppsCommand ¶
type AppsCommand struct {
// contains filtered or unexported fields
}
type AuthActor ¶
type AuthActor interface {
Authenticate(config v2action.Config, username string, password string) error
}
type AuthCommand ¶
type AuthCommand struct {
RequiredArgs flag.Authentication `positional-args:"yes"`
UI command.UI
Config command.Config
Actor AuthActor
// contains filtered or unexported fields
}
type BindRouteServiceCommand ¶
type BindRouteServiceCommand struct {
RequiredArgs flag.RouteServiceArgs `positional-args:"yes"`
ParametersAsJSON flag.Path `` /* 230-byte string literal not displayed */
Hostname string `long:"hostname" short:"n" description:"Hostname used in combination with DOMAIN to specify the route to bind"`
Path string `long:"path" description:"Path used in combination with HOSTNAME and DOMAIN to specify the route to bind"`
BackwardsCompatibility bool `short:"f" hidden:"true" description:"This is for backwards compatibility"`
// contains filtered or unexported fields
}
type BindRunningSecurityGroupCommand ¶
type BindRunningSecurityGroupCommand struct {
RequiredArgs flag.SecurityGroup `positional-args:"yes"`
// contains filtered or unexported fields
}
type BindSecurityGroupActor ¶
type BindSecurityGroupActor interface {
BindSecurityGroupToSpace(securityGroupGUID string, spaceGUID string, lifecycle ccv2.SecurityGroupLifecycle) (v2action.Warnings, error)
CloudControllerAPIVersion() string
GetOrganizationByName(orgName string) (v2action.Organization, v2action.Warnings, error)
GetOrganizationSpaces(orgGUID string) ([]v2action.Space, v2action.Warnings, error)
GetSecurityGroupByName(securityGroupName string) (v2action.SecurityGroup, v2action.Warnings, error)
GetSpaceByOrganizationAndName(orgGUID string, spaceName string) (v2action.Space, v2action.Warnings, error)
}
type BindSecurityGroupCommand ¶
type BindSecurityGroupCommand struct {
RequiredArgs flag.BindSecurityGroupArgs `positional-args:"yes"`
Lifecycle flag.SecurityGroupLifecycle `long:"lifecycle" choice:"running" choice:"staging" default:"running" description:"Lifecycle phase the group applies to"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor BindSecurityGroupActor
// contains filtered or unexported fields
}
type BindServiceActor ¶
type BindServiceActor interface {
BindServiceBySpace(appName string, ServiceInstanceName string, spaceGUID string, parameters map[string]interface{}) (v2action.Warnings, error)
}
type BindServiceCommand ¶
type BindServiceCommand struct {
RequiredArgs flag.BindServiceArgs `positional-args:"yes"`
ParametersAsJSON flag.JSONOrFileWithValidation `` /* 238-byte string literal not displayed */
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor BindServiceActor
// contains filtered or unexported fields
}
type BindStagingSecurityGroupCommand ¶
type BindStagingSecurityGroupCommand struct {
RequiredArgs flag.SecurityGroup `positional-args:"yes"`
// contains filtered or unexported fields
}
type BuildpacksCommand ¶
type BuildpacksCommand struct {
// contains filtered or unexported fields
}
type CheckRouteCommand ¶
type CheckRouteCommand struct {
RequiredArgs flag.HostDomain `positional-args:"yes"`
Path string `long:"path" description:"Path for the route"`
// contains filtered or unexported fields
}
type ConfigCommand ¶
type ConfigCommand struct {
AsyncTimeout int `long:"async-timeout" description:"Timeout for async HTTP requests"`
Color flag.Color `long:"color" description:"Enable or disable color"`
Locale flag.Locale `long:"locale" description:"Set default locale. If LOCALE is 'CLEAR', previous locale is deleted."`
Trace flag.PathWithBool `long:"trace" description:"Trace HTTP requests"`
// contains filtered or unexported fields
}
type CopySourceCommand ¶
type CopySourceCommand struct {
RequiredArgs flag.CopySourceArgs `positional-args:"yes"`
NoRestart bool `long:"no-restart" description:"Override restart of the application in target environment after copy-source completes"`
Organization string `short:"o" description:"Org that contains the target application"`
Space string `short:"s" description:"Space that contains the target application"`
// contains filtered or unexported fields
}
type CreateAppManifestActor ¶
type CreateAppManifestActor interface {
CreateApplicationManifestByNameAndSpace(appName string, spaceGUID string, filePath string) (v2action.Warnings, error)
}
type CreateAppManifestCommand ¶
type CreateAppManifestCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
FilePath flag.Path `` /* 135-byte string literal not displayed */
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor CreateAppManifestActor
// contains filtered or unexported fields
}
type CreateBuildpackCommand ¶
type CreateBuildpackCommand struct {
RequiredArgs flag.CreateBuildpackArgs `positional-args:"yes"`
Disable bool `long:"disable" description:"Disable the buildpack from being used for staging"`
Enable bool `long:"enable" description:"Enable the buildpack to be used for staging"`
// contains filtered or unexported fields
}
type CreateDomainCommand ¶
type CreateDomainCommand struct {
RequiredArgs flag.OrgDomain `positional-args:"yes"`
// contains filtered or unexported fields
}
type CreateOrgCommand ¶
type CreateOrgCommand struct {
RequiredArgs flag.Organization `positional-args:"yes"`
Quota string `` /* 127-byte string literal not displayed */
// contains filtered or unexported fields
}
type CreateQuotaCommand ¶
type CreateQuotaCommand struct {
RequiredArgs flag.Quota `positional-args:"yes"`
NumAppInstances int `short:"a" description:"Total number of application instances. -1 represents an unlimited amount. (Default: unlimited)"`
AllowPaidServicePlans bool `long:"allow-paid-service-plans" description:"Can provision instances of paid service plans"`
IndividualAppInstanceMemory flag.MemoryWithUnlimited `` /* 139-byte string literal not displayed */
TotalMemory string `short:"m" description:"Total amount of memory a space can have (e.g. 1024M, 1G, 10G)"`
NumRoutes int `short:"r" description:"Total number of routes"`
ReservedRoutePorts int `long:"reserved-route-ports" description:"Maximum number of routes that may be created with reserved ports (Default: 0)"`
NumServiceInstances int `short:"s" description:"Total number of service instances"`
// contains filtered or unexported fields
}
type CreateRouteActor ¶
type CreateRouteActor interface {
CloudControllerAPIVersion() string
CreateRouteWithExistenceCheck(orgGUID string, spaceName string, route v2action.Route, generatePort bool) (v2action.Route, v2action.Warnings, error)
}
type CreateRouteCommand ¶
type CreateRouteCommand struct {
RequiredArgs flag.SpaceDomain `positional-args:"yes"`
Hostname string `long:"hostname" short:"n" description:"Hostname for the HTTP route (required for shared domains)"`
Path string `long:"path" description:"Path for the HTTP route"`
Port flag.Port `long:"port" description:"Port for the TCP route"`
RandomPort bool `long:"random-port" description:"Create a random port for the TCP route"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor CreateRouteActor
// contains filtered or unexported fields
}
type CreateSecurityGroupCommand ¶
type CreateSecurityGroupCommand struct {
RequiredArgs flag.SecurityGroupArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type CreateServiceAuthTokenCommand ¶
type CreateServiceAuthTokenCommand struct {
RequiredArgs flag.ServiceAuthTokenArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type CreateServiceBrokerCommand ¶
type CreateServiceBrokerCommand struct {
RequiredArgs flag.ServiceBrokerArgs `positional-args:"yes"`
SpaceScoped bool `long:"space-scoped" description:"Make the broker's service plans only visible within the targeted space"`
// contains filtered or unexported fields
}
type CreateServiceCommand ¶
type CreateServiceCommand struct {
RequiredArgs flag.CreateServiceArgs `positional-args:"yes"`
ConfigurationFile flag.Path `` /* 238-byte string literal not displayed */
Tags string `short:"t" description:"User provided tags"`
// contains filtered or unexported fields
}
type CreateServiceKeyCommand ¶
type CreateServiceKeyCommand struct {
RequiredArgs flag.ServiceInstanceKey `positional-args:"yes"`
ParametersAsJSON flag.Path `` /* 238-byte string literal not displayed */
// contains filtered or unexported fields
}
type CreateSharedDomainCommand ¶
type CreateSharedDomainCommand struct {
RequiredArgs flag.Domain `positional-args:"yes"`
RouterGroup string `long:"router-group" description:"Routes for this domain will be configured only on the specified router group"`
// contains filtered or unexported fields
}
type CreateSpaceCommand ¶
type CreateSpaceCommand struct {
RequiredArgs flag.Space `positional-args:"yes"`
Organization string `short:"o" description:"Organization"`
Quota string `short:"q" description:"Quota to assign to the newly created space"`
// contains filtered or unexported fields
}
type CreateSpaceQuotaCommand ¶
type CreateSpaceQuotaCommand struct {
RequiredArgs flag.SpaceQuota `positional-args:"yes"`
NumAppInstances int `short:"a" description:"Total number of application instances. -1 represents an unlimited amount. (Default: unlimited)"`
AllowPaidServicePlans bool `long:"allow-paid-service-plans" description:"Can provision instances of paid service plans (Default: disallowed)"`
IndividualAppInstanceMemory flag.MemoryWithUnlimited `` /* 160-byte string literal not displayed */
TotalMemory string `short:"m" description:"Total amount of memory a space can have (e.g. 1024M, 1G, 10G)"`
NumRoutes int `short:"r" description:"Total number of routes"`
ReservedRoutePorts int `long:"reserved-route-ports" description:"Maximum number of routes that may be created with reserved ports (Default: 0)"`
NumServiceInstances int `short:"s" description:"Total number of service instances"`
// contains filtered or unexported fields
}
type CreateUserActor ¶
type CreateUserActor interface {
CreateUser(username string, password string, origin string) (v2action.User, v2action.Warnings, error)
}
type CreateUserCommand ¶
type CreateUserCommand struct {
Args flag.CreateUser `positional-args:"yes"`
Origin string `long:"origin" description:"Origin for mapping a user account to a user in an external identity provider"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor CreateUserActor
// contains filtered or unexported fields
}
type CreateUserProvidedServiceCommand ¶
type CreateUserProvidedServiceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
SyslogDrainURL string `short:"l" description:"URL to which logs for bound applications will be streamed"`
Credentials string `` /* 145-byte string literal not displayed */
RouteServiceURL string `short:"r" description:"URL to which requests for bound routes will be forwarded. Scheme for this URL must be https"`
// contains filtered or unexported fields
}
type CurlCommand ¶
type CurlCommand struct {
RequiredArgs flag.APIPath `positional-args:"yes"`
CustomHeaders []string `short:"H" description:"Custom headers to include in the request, flag can be specified multiple times"`
HTTPMethod string `short:"X" description:"HTTP method (GET,POST,PUT,DELETE,etc)"`
HTTPData flag.PathWithAt `short:"d" description:"HTTP data to include in the request body, or '@' followed by a file name to read the data from"`
IncludeReponseHeaders bool `short:"i" description:"Include response headers in the output"`
OutputFile flag.Path `long:"output" description:"Write curl body to FILE instead of stdout"`
// contains filtered or unexported fields
}
type DeleteBuildpackCommand ¶
type DeleteBuildpackCommand struct {
RequiredArgs flag.BuildpackName `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteCommand ¶
type DeleteCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
ForceDelete bool `short:"f" description:"Force deletion without confirmation"`
DeleteMappedRoutes bool `short:"r" description:"Also delete any mapped routes"`
// contains filtered or unexported fields
}
type DeleteDomainCommand ¶
type DeleteDomainCommand struct {
RequiredArgs flag.Domain `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteOrgCommand ¶
type DeleteOrgCommand struct {
RequiredArgs flag.Organization `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
Config command.Config
UI command.UI
SharedActor command.SharedActor
Actor DeleteOrganizationActor
// contains filtered or unexported fields
}
type DeleteOrganizationActor ¶
type DeleteOrganizationActor interface {
DeleteOrganization(orgName string) (v2action.Warnings, error)
ClearOrganizationAndSpace(config v2action.Config)
}
type DeleteOrphanedRoutesActor ¶
type DeleteOrphanedRoutesActor interface {
GetOrphanedRoutesBySpace(spaceGUID string) ([]v2action.Route, v2action.Warnings, error)
DeleteRoute(routeGUID string) (v2action.Warnings, error)
}
type DeleteOrphanedRoutesCommand ¶
type DeleteOrphanedRoutesCommand struct {
Force bool `short:"f" description:"Force deletion without confirmation"`
UI command.UI
Actor DeleteOrphanedRoutesActor
SharedActor command.SharedActor
Config command.Config
// contains filtered or unexported fields
}
type DeleteQuotaCommand ¶
type DeleteQuotaCommand struct {
RequiredArgs flag.Quota `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteRouteCommand ¶
type DeleteRouteCommand struct {
RequiredArgs flag.Domain `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
Hostname string `long:"hostname" short:"n" description:"Hostname used to identify the HTTP route"`
Path string `long:"path" description:"Path used to identify the HTTP route"`
Port int `long:"port" description:"Port used to identify the TCP route"`
// contains filtered or unexported fields
}
type DeleteSecurityGroupCommand ¶
type DeleteSecurityGroupCommand struct {
RequiredArgs flag.SecurityGroup `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteServiceAuthTokenCommand ¶
type DeleteServiceAuthTokenCommand struct {
RequiredArgs flag.DeleteServiceAuthTokenArgs `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteServiceBrokerCommand ¶
type DeleteServiceBrokerCommand struct {
RequiredArgs flag.ServiceBroker `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteServiceCommand ¶
type DeleteServiceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteServiceKeyCommand ¶
type DeleteServiceKeyCommand struct {
RequiredArgs flag.ServiceInstanceKey `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteSharedDomainCommand ¶
type DeleteSharedDomainCommand struct {
RequiredArgs flag.Domain `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteSpaceActor ¶
type DeleteSpaceActor interface {
DeleteSpaceByNameAndOrganizationName(spaceName string, orgName string) (v2action.Warnings, error)
}
type DeleteSpaceCommand ¶
type DeleteSpaceCommand struct {
RequiredArgs flag.Space `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
Org string `short:"o" description:"Delete space within specified org"`
Config command.Config
UI command.UI
SharedActor command.SharedActor
Actor DeleteSpaceActor
// contains filtered or unexported fields
}
type DeleteSpaceQuotaCommand ¶
type DeleteSpaceQuotaCommand struct {
RequiredArgs flag.SpaceQuota `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DeleteUserCommand ¶
type DeleteUserCommand struct {
RequiredArgs flag.Username `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type DisableFeatureFlagCommand ¶
type DisableFeatureFlagCommand struct {
RequiredArgs flag.Feature `positional-args:"yes"`
// contains filtered or unexported fields
}
type DisableSSHCommand ¶
type DisableSSHCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
// contains filtered or unexported fields
}
type DisableServiceAccessCommand ¶
type DisableServiceAccessCommand struct {
RequiredArgs flag.Service `positional-args:"yes"`
Organization string `short:"o" description:"Disable access for a specified organization"`
ServicePlan string `short:"p" description:"Disable access to a specified service plan"`
// contains filtered or unexported fields
}
type DisallowSpaceSSHCommand ¶
type DisallowSpaceSSHCommand struct {
RequiredArgs flag.Space `positional-args:"yes"`
// contains filtered or unexported fields
}
type DomainsCommand ¶
type DomainsCommand struct {
// contains filtered or unexported fields
}
type EnableFeatureFlagCommand ¶
type EnableFeatureFlagCommand struct {
RequiredArgs flag.Feature `positional-args:"yes"`
// contains filtered or unexported fields
}
type EnableSSHCommand ¶
type EnableSSHCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
// contains filtered or unexported fields
}
type EnableServiceAccessCommand ¶
type EnableServiceAccessCommand struct {
RequiredArgs flag.Service `positional-args:"yes"`
Organization string `short:"o" description:"Enable access for a specified organization"`
ServicePlan string `short:"p" description:"Enable access to a specified service plan"`
// contains filtered or unexported fields
}
type EnvCommand ¶
type EnvCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
// contains filtered or unexported fields
}
type EventsCommand ¶
type EventsCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
// contains filtered or unexported fields
}
type FeatureFlagCommand ¶
type FeatureFlagCommand struct {
RequiredArgs flag.Feature `positional-args:"yes"`
// contains filtered or unexported fields
}
type FeatureFlagsCommand ¶
type FeatureFlagsCommand struct {
// contains filtered or unexported fields
}
type FilesCommand ¶
type FilesCommand struct {
RequiredArgs flag.FilesArgs `positional-args:"yes"`
Instance int `short:"i" description:"Instance"`
// contains filtered or unexported fields
}
type GetHealthCheckActor ¶
type GetHealthCheckActor interface {
GetApplicationByNameAndSpace(name string, spaceGUID string) (v2action.Application, v2action.Warnings, error)
}
type GetHealthCheckCommand ¶
type GetHealthCheckCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor GetHealthCheckActor
// contains filtered or unexported fields
}
type LoginCommand ¶
type LoginCommand struct {
APIEndpoint string `short:"a" description:"API endpoint (e.g. https://api.example.com)"`
Organization string `short:"o" description:"Org"`
Password string `short:"p" description:"Password"`
Space string `short:"s" description:"Space"`
SkipSSLValidation bool `long:"skip-ssl-validation" description:"Skip verification of the API endpoint. Not recommended!"`
SSO bool `long:"sso" description:"Prompt for a one-time passcode to login"`
SSOPasscode string `long:"sso-passcode" description:"One-time passcode"`
Username string `short:"u" description:"Username"`
// contains filtered or unexported fields
}
type LogoutCommand ¶
type LogoutCommand struct {
// contains filtered or unexported fields
}
type LogsActor ¶
type LogsActor interface {
GetRecentLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client v2action.NOAAClient, config v2action.Config) ([]v2action.LogMessage, v2action.Warnings, error)
GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client v2action.NOAAClient, config v2action.Config) (<-chan *v2action.LogMessage, <-chan error, v2action.Warnings, error)
}
type LogsCommand ¶
type LogsCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
Recent bool `long:"recent" description:"Dump recent logs instead of tailing"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor LogsActor
NOAAClient *consumer.Consumer
// contains filtered or unexported fields
}
type MapRouteCommand ¶
type MapRouteCommand struct {
RequiredArgs flag.AppDomain `positional-args:"yes"`
Hostname string `long:"hostname" short:"n" description:"Hostname for the HTTP route (required for shared domains)"`
Path string `long:"path" description:"Path for the HTTP route"`
Port int `long:"port" description:"Port for the TCP route"`
RandomPort bool `long:"random-port" description:"Create a random port for the TCP route"`
// contains filtered or unexported fields
}
type MarketplaceCommand ¶
type MarketplaceCommand struct {
ServicePlanInfo string `short:"s" description:"Show plan details for a particular service offering"`
// contains filtered or unexported fields
}
type MigrateServiceInstancesCommand ¶
type MigrateServiceInstancesCommand struct {
RequiredArgs flag.MigrateServiceInstancesArgs `positional-args:"yes"`
Force bool `short:"f" description:"Force migration without confirmation"`
// contains filtered or unexported fields
}
type OauthTokenActor ¶
type OauthTokenActor interface {
RefreshAccessToken(refreshToken string) (string, error)
}
type OauthTokenCommand ¶
type OauthTokenCommand struct {
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor OauthTokenActor
// contains filtered or unexported fields
}
type OrgActor ¶
type OrgActor interface {
GetOrganizationByName(orgName string) (v2action.Organization, v2action.Warnings, error)
GetOrganizationSummaryByName(orgName string) (v2action.OrganizationSummary, v2action.Warnings, error)
}
type OrgActorV3 ¶
type OrgActorV3 interface {
GetIsolationSegmentsByOrganization(orgName string) ([]v3action.IsolationSegment, v3action.Warnings, error)
CloudControllerAPIVersion() string
}
type OrgCommand ¶
type OrgCommand struct {
RequiredArgs flag.Organization `positional-args:"yes"`
GUID bool `long:"guid" description:"Retrieve and display the given org's guid. All other output for the org is suppressed."`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor OrgActor
ActorV3 OrgActorV3
// contains filtered or unexported fields
}
type OrgUsersCommand ¶
type OrgUsersCommand struct {
RequiredArgs flag.Organization `positional-args:"yes"`
AllUsers bool `short:"a" description:"List all users in the org"`
// contains filtered or unexported fields
}
type OrgsActor ¶
type OrgsActor interface {
GetOrganizations() ([]v2action.Organization, v2action.Warnings, error)
}
type OrgsCommand ¶
type OrgsCommand struct {
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor OrgsActor
// contains filtered or unexported fields
}
type PasswdCommand ¶
type PasswdCommand struct {
// contains filtered or unexported fields
}
type ProgressBar ¶
type ProgressBar interface {
pushaction.ProgressBar
Complete()
Ready()
}
type PurgeServiceInstanceCommand ¶
type PurgeServiceInstanceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
// contains filtered or unexported fields
}
type PurgeServiceOfferingCommand ¶
type PurgeServiceOfferingCommand struct {
RequiredArgs flag.Service `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
Provider string `short:"p" description:"Provider"`
// contains filtered or unexported fields
}
type PushCommand ¶
type PushCommand struct {
AppPorts string `long:"app-ports" description:"Comma delimited list of ports the application may listen on" hidden:"true"` //TODO: Custom AppPorts flag
BuildpackName string `` /* 317-byte string literal not displayed */
StartupCommand string `short:"c" description:"Startup command, set to null to reset to default start command"`
Domain string `short:"d" description:"Domain (e.g. example.com)"`
DockerImage string `long:"docker-image" short:"o" description:"Docker-image to be used (e.g. user/docker-image-name)"`
DockerUsername string `long:"docker-username" description:"Repository username; used with password from environment variable CF_DOCKER_PASSWORD"`
PathToManifest flag.PathWithExistenceCheck `short:"f" description:"Path to manifest"`
HealthCheckType flag.HealthCheckType `` /* 156-byte string literal not displayed */
Hostname string `long:"hostname" short:"n" description:"Hostname (e.g. my-subdomain)"`
NumInstances int `short:"i" description:"Number of instances"`
DiskLimit string `short:"k" description:"Disk limit (e.g. 256M, 1024M, 1G)"`
MemoryLimit string `short:"m" description:"Memory limit (e.g. 256M, 1024M, 1G)"`
NoHostname bool `long:"no-hostname" description:"Map the root domain to this app"`
NoManifest bool `long:"no-manifest" description:"Ignore manifest file"`
NoRoute bool `long:"no-route" description:"Do not map a route to this app and remove routes from previous pushes of this app"`
NoStart bool `long:"no-start" description:"Do not start an app after pushing"`
DirectoryPath flag.PathWithExistenceCheck `short:"p" description:"Path to app directory or to a zip file of the contents of the app directory"`
RandomRoute bool `long:"random-route" description:"Create a random route for this app"`
RoutePath string `long:"route-path" description:"Path for the route"`
Stack string `short:"s" description:"Stack to use (a stack is a pre-built file system, including an operating system, that can run apps)"`
ApplicationStartTime int `` /* 130-byte string literal not displayed */
// contains filtered or unexported fields
}
type QuotaCommand ¶
type QuotaCommand struct {
RequiredArgs flag.Quota `positional-args:"yes"`
// contains filtered or unexported fields
}
type QuotasCommand ¶
type QuotasCommand struct {
// contains filtered or unexported fields
}
type RenameBuildpackCommand ¶
type RenameBuildpackCommand struct {
RequiredArgs flag.RenameBuildpackArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type RenameCommand ¶
type RenameCommand struct {
RequiredArgs flag.AppRenameArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type RenameOrgCommand ¶
type RenameOrgCommand struct {
RequiredArgs flag.RenameOrgArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type RenameServiceBrokerCommand ¶
type RenameServiceBrokerCommand struct {
RequiredArgs flag.RenameServiceBrokerArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type RenameServiceCommand ¶
type RenameServiceCommand struct {
RequiredArgs flag.RenameServiceArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type RenameSpaceCommand ¶
type RenameSpaceCommand struct {
RequiredArgs flag.RenameSpaceArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type RestageActor ¶
type RestageActor interface {
AppActor
RestageApplication(app v2action.Application, client v2action.NOAAClient, config v2action.Config) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error)
}
type RestageCommand ¶
type RestageCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor RestageActor
NOAAClient *consumer.Consumer
// contains filtered or unexported fields
}
type RestartActor ¶
type RestartActor interface {
AppActor
RestartApplication(app v2action.Application, client v2action.NOAAClient, config v2action.Config) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error)
}
type RestartAppInstanceCommand ¶
type RestartAppInstanceCommand struct {
RequiredArgs flag.AppInstance `positional-args:"yes"`
// contains filtered or unexported fields
}
type RestartCommand ¶
type RestartCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor RestartActor
NOAAClient *consumer.Consumer
// contains filtered or unexported fields
}
type RouterGroupsCommand ¶
type RouterGroupsCommand struct {
// contains filtered or unexported fields
}
type RoutesCommand ¶
type RoutesCommand struct {
OrgLevel bool `long:"orglevel" description:"List all the routes for all spaces of current organization"`
// contains filtered or unexported fields
}
type RunningEnvironmentVariableGroupCommand ¶
type RunningEnvironmentVariableGroupCommand struct {
// contains filtered or unexported fields
}
type RunningSecurityGroupsCommand ¶
type RunningSecurityGroupsCommand struct {
// contains filtered or unexported fields
}
type SSHCodeActor ¶
type SSHCodeActor interface {
GetSSHPasscode() (string, error)
}
type SSHCodeCommand ¶
type SSHCodeCommand struct {
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor SSHCodeActor
// contains filtered or unexported fields
}
type SSHCommand ¶
type SSHCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
AppInstanceIndex int `long:"app-instance-index" short:"i" description:"Application instance index (Default: 0)"`
Command string `long:"command" short:"c" description:"Command to run. This flag can be defined more than once."`
DisablePseudoTTY bool `long:"disable-pseudo-tty" short:"T" description:"Disable pseudo-tty allocation"`
ForcePseudoTTY bool `long:"force-pseudo-tty" description:"Force pseudo-tty allocation"`
LocalPort string `short:"L" description:"Local port forward specification. This flag can be defined more than once."`
RemotePseudoTTY bool `long:"request-pseudo-tty" short:"t" description:"Request pseudo-tty allocation"`
SkipHostValidation bool `long:"skip-host-validation" short:"k" description:"Skip host key validation"`
SkipRemoteExecution bool `long:"skip-remote-execution" short:"N" description:"Do not execute a remote command"`
// contains filtered or unexported fields
}
type SSHEnabledCommand ¶
type SSHEnabledCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
// contains filtered or unexported fields
}
type ScaleCommand ¶
type ScaleCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
ForceRestart bool `short:"f" description:"Force restart of app without prompt"`
NumInstances int `short:"i" description:"Number of instances"`
DiskLimit string `short:"k" description:"Disk limit (e.g. 256M, 1024M, 1G)"`
MemoryLimit string `short:"m" description:"Memory limit (e.g. 256M, 1024M, 1G)"`
// contains filtered or unexported fields
}
type SecurityGroupCommand ¶
type SecurityGroupCommand struct {
RequiredArgs flag.SecurityGroup `positional-args:"yes"`
// contains filtered or unexported fields
}
type SecurityGroupsActor ¶
type SecurityGroupsActor interface {
CloudControllerAPIVersion() string
GetSecurityGroupsWithOrganizationSpaceAndLifecycle(includeStaging bool) ([]v2action.SecurityGroupWithOrganizationSpaceAndLifecycle, v2action.Warnings, error)
}
type SecurityGroupsCommand ¶
type SecurityGroupsCommand struct {
SharedActor command.SharedActor
Config command.Config
UI command.UI
Actor SecurityGroupsActor
// contains filtered or unexported fields
}
type ServiceAccessCommand ¶
type ServiceAccessCommand struct {
Broker string `short:"b" description:"Access for plans of a particular broker"`
Service string `short:"e" description:"Access for service name of a particular service offering"`
Organization string `short:"o" description:"Plans accessible by a particular organization"`
// contains filtered or unexported fields
}
type ServiceActor ¶
type ServiceActor interface {
GetServiceInstanceByNameAndSpace(name string, spaceGUID string) (v2action.ServiceInstance, v2action.Warnings, error)
GetServiceInstanceSummaryByNameAndSpace(name string, spaceGUID string) (v2action.ServiceInstanceSummary, v2action.Warnings, error)
}
type ServiceAuthTokensCommand ¶
type ServiceAuthTokensCommand struct {
// contains filtered or unexported fields
}
type ServiceBrokersCommand ¶
type ServiceBrokersCommand struct {
// contains filtered or unexported fields
}
type ServiceCommand ¶
type ServiceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
GUID bool `long:"guid" description:"Retrieve and display the given service's guid. All other output for the service is suppressed."`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor ServiceActor
// contains filtered or unexported fields
}
type ServiceKeyCommand ¶
type ServiceKeyCommand struct {
RequiredArgs flag.ServiceInstanceKey `positional-args:"yes"`
GUID bool `long:"guid" description:"Retrieve and display the given service-key's guid. All other output for the service is suppressed."`
// contains filtered or unexported fields
}
type ServiceKeysCommand ¶
type ServiceKeysCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
// contains filtered or unexported fields
}
type ServicesCommand ¶
type ServicesCommand struct {
// contains filtered or unexported fields
}
type SetEnvCommand ¶
type SetEnvCommand struct {
RequiredArgs flag.SetEnvironmentArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type SetHealthCheckActor ¶
type SetHealthCheckActor interface {
SetApplicationHealthCheckTypeByNameAndSpace(name string, spaceGUID string, healthCheckType constant.ApplicationHealthCheckType, httpEndpoint string) (v2action.Application, v2action.Warnings, error)
CloudControllerAPIVersion() string
}
type SetHealthCheckCommand ¶
type SetHealthCheckCommand struct {
RequiredArgs flag.SetHealthCheckArgs `positional-args:"yes"`
HTTPEndpoint string `long:"endpoint" default:"/" description:"Path on the app"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor SetHealthCheckActor
// contains filtered or unexported fields
}
type SetOrgRoleCommand ¶
type SetOrgRoleCommand struct {
RequiredArgs flag.SetOrgRoleArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type SetQuotaCommand ¶
type SetQuotaCommand struct {
RequiredArgs flag.SetOrgQuotaArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type SetRunningEnvironmentVariableGroupCommand ¶
type SetRunningEnvironmentVariableGroupCommand struct {
RequiredArgs flag.ParamsAsJSON `positional-args:"yes"`
// contains filtered or unexported fields
}
type SetSpaceQuotaCommand ¶
type SetSpaceQuotaCommand struct {
RequiredArgs flag.SetSpaceQuotaArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type SetSpaceRoleCommand ¶
type SetSpaceRoleCommand struct {
RequiredArgs flag.SetSpaceRoleArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type SetStagingEnvironmentVariableGroupCommand ¶
type SetStagingEnvironmentVariableGroupCommand struct {
RequiredArgs flag.ParamsAsJSON `positional-args:"yes"`
// contains filtered or unexported fields
}
type SharePrivateDomainCommand ¶
type SharePrivateDomainCommand struct {
RequiredArgs flag.OrgDomain `positional-args:"yes"`
// contains filtered or unexported fields
}
type SpaceActor ¶
type SpaceActor interface {
CloudControllerAPIVersion() string
GetSpaceByOrganizationAndName(orgGUID string, spaceName string) (v2action.Space, v2action.Warnings, error)
GetSpaceSummaryByOrganizationAndName(orgGUID string, spaceName string, includeStagingSecurityGroupsRules bool) (v2action.SpaceSummary, v2action.Warnings, error)
}
type SpaceActorV3 ¶
type SpaceActorV3 interface {
CloudControllerAPIVersion() string
GetEffectiveIsolationSegmentBySpace(spaceGUID string, orgDefaultIsolationSegmentGUID string) (v3action.IsolationSegment, v3action.Warnings, error)
}
type SpaceCommand ¶
type SpaceCommand struct {
RequiredArgs flag.Space `positional-args:"yes"`
GUID bool `long:"guid" description:"Retrieve and display the given space's guid. All other output for the space is suppressed."`
SecurityGroupRules bool `long:"security-group-rules" description:"Retrieve the rules for all the security groups associated with the space."`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor SpaceActor
ActorV3 SpaceActorV3
// contains filtered or unexported fields
}
type SpaceQuotaCommand ¶
type SpaceQuotaCommand struct {
RequiredArgs flag.SpaceQuota `positional-args:"yes"`
// contains filtered or unexported fields
}
type SpaceQuotasCommand ¶
type SpaceQuotasCommand struct {
// contains filtered or unexported fields
}
type SpaceSSHAllowedCommand ¶
type SpaceSSHAllowedCommand struct {
RequiredArgs flag.Space `positional-args:"yes"`
// contains filtered or unexported fields
}
type SpaceUsersCommand ¶
type SpaceUsersCommand struct {
RequiredArgs flag.OrgSpace `positional-args:"yes"`
// contains filtered or unexported fields
}
type SpacesActor ¶
type SpacesActor interface {
GetOrganizationSpaces(orgGUID string) ([]v2action.Space, v2action.Warnings, error)
}
type SpacesCommand ¶
type SpacesCommand struct {
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor SpacesActor
// contains filtered or unexported fields
}
type StackCommand ¶
type StackCommand struct {
RequiredArgs flag.StackName `positional-args:"yes"`
GUID bool `long:"guid" description:"Retrieve and display the given stack's guid. All other output for the stack is suppressed."`
// contains filtered or unexported fields
}
type StacksCommand ¶
type StacksCommand struct {
// contains filtered or unexported fields
}
type StagingEnvironmentVariableGroupCommand ¶
type StagingEnvironmentVariableGroupCommand struct {
// contains filtered or unexported fields
}
type StagingSecurityGroupsCommand ¶
type StagingSecurityGroupsCommand struct {
// contains filtered or unexported fields
}
type StartActor ¶
type StartActor interface {
AppActor
StartApplication(app v2action.Application, client v2action.NOAAClient, config v2action.Config) (<-chan *v2action.LogMessage, <-chan error, <-chan v2action.ApplicationStateChange, <-chan string, <-chan error)
}
type StartCommand ¶
type StartCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor StartActor
NOAAClient *consumer.Consumer
// contains filtered or unexported fields
}
type StopCommand ¶
type StopCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
// contains filtered or unexported fields
}
type TargetActor ¶
type TargetActor interface {
GetOrganizationByName(orgName string) (v2action.Organization, v2action.Warnings, error)
GetOrganizationSpaces(orgGUID string) ([]v2action.Space, v2action.Warnings, error)
GetSpaceByOrganizationAndName(orgGUID string, spaceName string) (v2action.Space, v2action.Warnings, error)
}
type TargetCommand ¶
type TargetCommand struct {
Organization string `short:"o" description:"Organization"`
Space string `short:"s" description:"Space"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor TargetActor
// contains filtered or unexported fields
}
type UnbindRouteServiceCommand ¶
type UnbindRouteServiceCommand struct {
RequiredArgs flag.RouteServiceArgs `positional-args:"yes"`
Force bool `short:"f" description:"Force unbinding without confirmation"`
Hostname string `long:"hostname" short:"n" description:"Hostname used in combination with DOMAIN to specify the route to unbind"`
Path string `long:"path" description:"Path used in combination with HOSTNAME and DOMAIN to specify the route to unbind"`
// contains filtered or unexported fields
}
type UnbindRunningSecurityGroupCommand ¶
type UnbindRunningSecurityGroupCommand struct {
RequiredArgs flag.SecurityGroup `positional-args:"yes"`
// contains filtered or unexported fields
}
type UnbindSecurityGroupActor ¶
type UnbindSecurityGroupActor interface {
CloudControllerAPIVersion() string
UnbindSecurityGroupByNameAndSpace(securityGroupName string, spaceGUID string, lifecycle ccv2.SecurityGroupLifecycle) (v2action.Warnings, error)
UnbindSecurityGroupByNameOrganizationNameAndSpaceName(securityGroupName string, orgName string, spaceName string, lifecycle ccv2.SecurityGroupLifecycle) (v2action.Warnings, error)
}
type UnbindSecurityGroupCommand ¶
type UnbindSecurityGroupCommand struct {
RequiredArgs flag.UnbindSecurityGroupArgs `positional-args:"yes"`
Lifecycle flag.SecurityGroupLifecycle `long:"lifecycle" choice:"running" choice:"staging" default:"running" description:"Lifecycle phase the group applies to"`
UI command.UI
Config command.Config
Actor UnbindSecurityGroupActor
SharedActor command.SharedActor
// contains filtered or unexported fields
}
type UnbindServiceActor ¶
type UnbindServiceActor interface {
UnbindServiceBySpace(appName string, serviceInstanceName string, spaceGUID string) (v2action.Warnings, error)
}
type UnbindServiceCommand ¶
type UnbindServiceCommand struct {
RequiredArgs flag.BindServiceArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor UnbindServiceActor
// contains filtered or unexported fields
}
type UnbindStagingSecurityGroupCommand ¶
type UnbindStagingSecurityGroupCommand struct {
RequiredArgs flag.SecurityGroup `positional-args:"yes"`
// contains filtered or unexported fields
}
type UnmapRouteCommand ¶
type UnmapRouteCommand struct {
RequiredArgs flag.AppDomain `positional-args:"yes"`
Hostname string `long:"hostname" short:"n" description:"Hostname used to identify the HTTP route"`
Path string `long:"path" description:"Path used to identify the HTTP route"`
Port int `long:"port" description:"Port used to identify the TCP route"`
// contains filtered or unexported fields
}
type UnsetEnvCommand ¶
type UnsetEnvCommand struct {
// contains filtered or unexported fields
}
type UnsetOrgRoleCommand ¶
type UnsetOrgRoleCommand struct {
RequiredArgs flag.SetOrgRoleArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type UnsetSpaceQuotaCommand ¶
type UnsetSpaceQuotaCommand struct {
RequiredArgs flag.SetSpaceQuotaArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type UnsetSpaceRoleCommand ¶
type UnsetSpaceRoleCommand struct {
RequiredArgs flag.SetSpaceRoleArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type UnsharePrivateDomainCommand ¶
type UnsharePrivateDomainCommand struct {
RequiredArgs flag.OrgDomain `positional-args:"yes"`
// contains filtered or unexported fields
}
type UpdateBuildpackCommand ¶
type UpdateBuildpackCommand struct {
RequiredArgs flag.BuildpackName `positional-args:"yes"`
Disable bool `long:"disable" description:"Disable the buildpack from being used for staging"`
Enable bool `long:"enable" description:"Enable the buildpack to be used for staging"`
Order int `short:"i" description:"The order in which the buildpacks are checked during buildpack auto-detection"`
Lock bool `long:"lock" description:"Lock the buildpack to prevent updates"`
Path flag.PathWithExistenceCheckOrURL `short:"p" description:"Path to directory or zip file"`
Unlock bool `long:"unlock" description:"Unlock the buildpack to enable updates"`
// contains filtered or unexported fields
}
type UpdateQuotaCommand ¶
type UpdateQuotaCommand struct {
RequiredArgs flag.Quota `positional-args:"yes"`
NumAppInstances int `short:"a" description:"Total number of application instances. -1 represents an unlimited amount."`
AllowPaidServicePlans bool `long:"allow-paid-service-plans" description:"Can provision instances of paid service plans"`
DisallowPaidServicePlans bool `long:"disallow-paid-service-plans" description:"Cannot provision instances of paid service plans"`
AppInstanceMemory flag.MemoryWithUnlimited `short:"i" description:"Maximum amount of memory an application instance can have (e.g. 1024M, 1G, 10G)"`
TotalMemory string `short:"m" description:"Total amount of memory (e.g. 1024M, 1G, 10G)"`
NewName string `short:"n" description:"New name"`
NumRoutes int `short:"r" description:"Total number of routes"`
ReservedRoutePorts int `long:"reserved-route-ports" description:"Maximum number of routes that may be created with reserved ports"`
NumServiceInstances int `short:"s" description:"Total number of service instances"`
// contains filtered or unexported fields
}
type UpdateSecurityGroupCommand ¶
type UpdateSecurityGroupCommand struct {
RequiredArgs flag.SecurityGroupArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type UpdateServiceAuthTokenCommand ¶
type UpdateServiceAuthTokenCommand struct {
RequiredArgs flag.ServiceAuthTokenArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type UpdateServiceBrokerCommand ¶
type UpdateServiceBrokerCommand struct {
RequiredArgs flag.ServiceBrokerArgs `positional-args:"yes"`
// contains filtered or unexported fields
}
type UpdateServiceCommand ¶
type UpdateServiceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
ParametersAsJSON flag.Path `` /* 238-byte string literal not displayed */
Plan string `short:"p" description:"Change service plan for a service instance"`
Tags string `short:"t" description:"User provided tags"`
// contains filtered or unexported fields
}
type UpdateSpaceQuotaCommand ¶
type UpdateSpaceQuotaCommand struct {
RequiredArgs flag.SpaceQuota `positional-args:"yes"`
NumAppInstances int `short:"a" description:"Total number of application instances. -1 represents an unlimited amount."`
AllowPaidServicePlans bool `long:"allow-paid-service-plans" description:"Can provision instances of paid service plans"`
DisallowPaidServicePlans bool `long:"disallow-paid-service-plans" description:"Can not provision instances of paid service plans"`
AppInstanceMemory flag.MemoryWithUnlimited `` /* 139-byte string literal not displayed */
TotalMemory string `short:"m" description:"Total amount of memory a space can have (e.g. 1024M, 1G, 10G)"`
Name string `short:"n" description:"New name"`
NumRoutes int `short:"r" description:"Total number of routes"`
ReservedRoutePorts int `long:"reserved-route-ports" description:"Maximum number of routes that may be created with reserved ports"`
NumServiceInstances int `short:"s" description:"Total number of service instances"`
// contains filtered or unexported fields
}
type UpdateUserProvidedServiceCommand ¶
type UpdateUserProvidedServiceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
SyslogDrainURL string `short:"l" description:"URL to which logs for bound applications will be streamed"`
Credentials string `` /* 145-byte string literal not displayed */
RouteServiceURL string `short:"r" description:"URL to which requests for bound routes will be forwarded. Scheme for this URL must be https"`
// contains filtered or unexported fields
}
type V2PushActor ¶
type V2PushActor interface {
Apply(config pushaction.ApplicationConfig, progressBar pushaction.ProgressBar) (<-chan pushaction.ApplicationConfig, <-chan pushaction.Event, <-chan pushaction.Warnings, <-chan error)
ConvertToApplicationConfigs(orgGUID string, spaceGUID string, noStart bool, apps []manifest.Application) ([]pushaction.ApplicationConfig, pushaction.Warnings, error)
MergeAndValidateSettingsAndManifests(cmdSettings pushaction.CommandLineSettings, apps []manifest.Application) ([]manifest.Application, error)
ReadManifest(pathToManifest string) ([]manifest.Application, error)
}
type V2PushCommand ¶
type V2PushCommand struct {
OptionalArgs flag.OptionalAppName `positional-args:"yes"`
Buildpack flag.Buildpack `` /* 317-byte string literal not displayed */
Command flag.Command `short:"c" description:"Startup command, set to null to reset to default start command"`
Domain string `short:"d" description:"Domain (e.g. example.com)"`
DockerImage flag.DockerImage `long:"docker-image" short:"o" description:"Docker-image to be used (e.g. user/docker-image-name)"`
DockerUsername string `long:"docker-username" description:"Repository username; used with password from environment variable CF_DOCKER_PASSWORD"`
PathToManifest flag.PathWithExistenceCheck `short:"f" description:"Path to manifest"`
HealthCheckType flag.HealthCheckType `` /* 156-byte string literal not displayed */
Hostname string `long:"hostname" short:"n" description:"Hostname (e.g. my-subdomain)"`
Instances flag.Instances `short:"i" description:"Number of instances"`
DiskQuota flag.Megabytes `short:"k" description:"Disk limit (e.g. 256M, 1024M, 1G)"`
Memory flag.Megabytes `short:"m" description:"Memory limit (e.g. 256M, 1024M, 1G)"`
NoHostname bool `long:"no-hostname" description:"Map the root domain to this app"`
NoManifest bool `long:"no-manifest" description:"Ignore manifest file"`
NoRoute bool `long:"no-route" description:"Do not map a route to this app and remove routes from previous pushes of this app"`
NoStart bool `long:"no-start" description:"Do not start an app after pushing"`
AppPath flag.PathWithExistenceCheck `short:"p" description:"Path to app directory or to a zip file of the contents of the app directory"`
RandomRoute bool `long:"random-route" description:"Create a random route for this app"`
RoutePath flag.RoutePath `long:"route-path" description:"Path for the route"`
StackName string `short:"s" description:"Stack to use (a stack is a pre-built file system, including an operating system, that can run apps)"`
HealthCheckTimeout int `` /* 130-byte string literal not displayed */
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V2PushActor
ProgressBar ProgressBar
RestartActor RestartActor
NOAAClient *consumer.Consumer
// contains filtered or unexported fields
}
func (V2PushCommand) GetCommandLineSettings ¶
func (cmd V2PushCommand) GetCommandLineSettings() (pushaction.CommandLineSettings, error)
GetCommandLineSettings generates a push CommandLineSettings object from the command's command line flags. It also validates those settings, preventing contradictory flags.
Source Files
¶
- allow_space_ssh_command.go
- api_command.go
- app_command.go
- apps_command.go
- auth_command.go
- bind_route_service_command.go
- bind_running_security_group_command.go
- bind_security_group_command.go
- bind_service_command.go
- bind_staging_security_group_command.go
- buildpacks_command.go
- check_route_command.go
- config_command.go
- copy_source_command.go
- create_app_manifest_command.go
- create_buildpack_command.go
- create_domain_command.go
- create_org_command.go
- create_quota_command.go
- create_route_command.go
- create_security_group_command.go
- create_service_auth_token_command.go
- create_service_broker_command.go
- create_service_command.go
- create_service_key_command.go
- create_shared_domain_command.go
- create_space_command.go
- create_space_quota_command.go
- create_user_command.go
- create_user_provided_service_command.go
- curl_command.go
- delete_buildpack_command.go
- delete_command.go
- delete_domain_command.go
- delete_org_command.go
- delete_orphaned_routes_command.go
- delete_quota_command.go
- delete_route_command.go
- delete_security_group_command.go
- delete_service_auth_token_command.go
- delete_service_broker_command.go
- delete_service_command.go
- delete_service_key_command.go
- delete_shared_domain_command.go
- delete_space_command.go
- delete_space_quota_command.go
- delete_user_command.go
- disable_feature_flag_command.go
- disable_service_access_command.go
- disable_ssh_command.go
- disallow_space_ssh_command.go
- domains_command.go
- enable_feature_flag_command.go
- enable_service_access_command.go
- enable_ssh_command.go
- env_command.go
- events_command.go
- feature_flag_command.go
- feature_flags_command.go
- files_command.go
- get_health_check_command.go
- godoc.go
- login_command.go
- logout_command.go
- logs_command.go
- map_route_command.go
- marketplace_command.go
- migrate_service_instances_command.go
- oauth_token_command.go
- org_command.go
- org_users_command.go
- orgs_command.go
- passwd_command.go
- purge_service_instance_command.go
- purge_service_offering_command.go
- push_command.go
- quota_command.go
- quotas_command.go
- rename_buildpack_command.go
- rename_command.go
- rename_org_command.go
- rename_service_broker_command.go
- rename_service_command.go
- rename_space_command.go
- restage_command.go
- restart_app_instance_command.go
- restart_command.go
- router_groups_command.go
- routes_command.go
- running_environment_variable_group_command.go
- running_security_groups_command.go
- scale_command.go
- security_group_command.go
- security_groups_command.go
- service_access_command.go
- service_auth_tokens_command.go
- service_brokers_command.go
- service_command.go
- service_key_command.go
- service_keys_command.go
- services_command.go
- set_env_command.go
- set_health_check_command.go
- set_org_role_command.go
- set_quota_command.go
- set_running_environment_variable_group_command.go
- set_space_quota_command.go
- set_space_role_command.go
- set_staging_environment_variable_group_command.go
- share_private_domain_command.go
- space_command.go
- space_quota_command.go
- space_quotas_command.go
- space_ssh_allowed_command.go
- space_users_command.go
- spaces_command.go
- ssh_code_command.go
- ssh_command.go
- ssh_enabled_command.go
- stack_command.go
- stacks_command.go
- staging_environment_variable_group_command.go
- staging_security_groups_command.go
- start_command.go
- stop_command.go
- target_command.go
- unbind_route_service_command.go
- unbind_running_security_group_command.go
- unbind_security_group_command.go
- unbind_service_command.go
- unbind_staging_security_group_command.go
- unmap_route_command.go
- unset_env_command.go
- unset_org_role_command.go
- unset_space_quota_command.go
- unset_space_role_command.go
- unshare_private_domain_command.go
- update_buildpack_command.go
- update_quota_command.go
- update_security_group_command.go
- update_service_auth_token_command.go
- update_service_broker_command.go
- update_service_command.go
- update_space_quota_command.go
- update_user_provided_service_command.go
- v2_push_command.go
Click to show internal directories.
Click to hide internal directories.