Documentation
¶
Overview ¶
Package v3 should not be imported by external consumers. It was not designed for external use.
Index ¶
- type AddNetworkPolicyActor
- type AddNetworkPolicyCommand
- type CreateIsolationSegmentActor
- type CreateIsolationSegmentCommand
- type DeleteIsolationSegmentActor
- type DeleteIsolationSegmentCommand
- type DisableOrgIsolationActor
- type DisableOrgIsolationCommand
- type EnableOrgIsolationActor
- type EnableOrgIsolationCommand
- type IsolationSegmentsActor
- type IsolationSegmentsCommand
- type ManifestParser
- type NetworkPoliciesActor
- type NetworkPoliciesCommand
- type RemoveNetworkPolicyActor
- type RemoveNetworkPolicyCommand
- type ResetOrgDefaultIsolationSegmentActor
- type ResetOrgDefaultIsolationSegmentActorV2
- type ResetOrgDefaultIsolationSegmentCommand
- type ResetSpaceIsolationSegmentActor
- type ResetSpaceIsolationSegmentActorV2
- type ResetSpaceIsolationSegmentCommand
- type RunTaskActor
- type RunTaskCommand
- type SSHActor
- type SetOrgDefaultIsolationSegmentActor
- type SetOrgDefaultIsolationSegmentActorV2
- type SetOrgDefaultIsolationSegmentCommand
- type SetSpaceIsolationSegmentActor
- type SetSpaceIsolationSegmentActorV2
- type SetSpaceIsolationSegmentCommand
- type ShareServiceActor
- type ShareServiceCommand
- type TasksActor
- type TasksCommand
- type TerminateTaskActor
- type TerminateTaskCommand
- type UnshareServiceActor
- type UnshareServiceCommand
- type V2PushActor
- type V3AppActor
- type V3AppCommand
- type V3ApplyManifestActor
- type V3ApplyManifestCommand
- type V3AppsActor
- type V3AppsCommand
- type V3CreateAppActor
- type V3CreateAppCommand
- type V3CreatePackageActor
- type V3CreatePackageCommand
- type V3DeleteActor
- type V3DeleteCommand
- type V3DropletsActor
- type V3DropletsCommand
- type V3EnvActor
- type V3EnvCommand
- type V3GetHealthCheckActor
- type V3GetHealthCheckCommand
- type V3PackagesActor
- type V3PackagesCommand
- type V3PushActor
- type V3PushCommand
- type V3RestartActor
- type V3RestartAppInstanceActor
- type V3RestartAppInstanceCommand
- type V3RestartCommand
- type V3SSHActor
- type V3SSHCommand
- type V3ScaleActor
- type V3ScaleCommand
- type V3SetDropletActor
- type V3SetDropletCommand
- type V3SetEnvActor
- type V3SetEnvCommand
- type V3SetHealthCheckActor
- type V3SetHealthCheckCommand
- type V3StageActor
- type V3StageCommand
- type V3StartActor
- type V3StartCommand
- type V3StopActor
- type V3StopCommand
- type V3UnsetEnvActor
- type V3UnsetEnvCommand
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddNetworkPolicyActor ¶
type AddNetworkPolicyActor interface {
AddNetworkPolicy(spaceGUID string, srcAppName string, destAppName string, protocol string, startPort int, endPort int) (cfnetworkingaction.Warnings, error)
}
type AddNetworkPolicyCommand ¶
type AddNetworkPolicyCommand struct {
RequiredArgs flag.AddNetworkPolicyArgs `positional-args:"yes"`
DestinationApp string `long:"destination-app" required:"true" description:"Name of app to connect to"`
Port flag.NetworkPort `long:"port" description:"Port or range of ports for connection to destination app (Default: 8080)"`
Protocol flag.NetworkProtocol `long:"protocol" description:"Protocol to connect apps with (Default: tcp)"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor AddNetworkPolicyActor
// contains filtered or unexported fields
}
type CreateIsolationSegmentActor ¶
type CreateIsolationSegmentActor interface {
CloudControllerAPIVersion() string
CreateIsolationSegmentByName(isolationSegment v3action.IsolationSegment) (v3action.Warnings, error)
}
type CreateIsolationSegmentCommand ¶
type CreateIsolationSegmentCommand struct {
RequiredArgs flag.IsolationSegmentName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor CreateIsolationSegmentActor
// contains filtered or unexported fields
}
type DeleteIsolationSegmentActor ¶
type DeleteIsolationSegmentActor interface {
CloudControllerAPIVersion() string
DeleteIsolationSegmentByName(name string) (v3action.Warnings, error)
}
type DeleteIsolationSegmentCommand ¶
type DeleteIsolationSegmentCommand struct {
RequiredArgs flag.IsolationSegmentName `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor DeleteIsolationSegmentActor
// contains filtered or unexported fields
}
type DisableOrgIsolationActor ¶
type DisableOrgIsolationActor interface {
CloudControllerAPIVersion() string
RevokeIsolationSegmentFromOrganizationByName(isolationSegmentName string, orgName string) (v3action.Warnings, error)
}
type DisableOrgIsolationCommand ¶
type DisableOrgIsolationCommand struct {
RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor DisableOrgIsolationActor
// contains filtered or unexported fields
}
type EnableOrgIsolationActor ¶
type EnableOrgIsolationActor interface {
CloudControllerAPIVersion() string
EntitleIsolationSegmentToOrganizationByName(isolationSegmentName string, orgName string) (v3action.Warnings, error)
}
type EnableOrgIsolationCommand ¶
type EnableOrgIsolationCommand struct {
RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor EnableOrgIsolationActor
// contains filtered or unexported fields
}
type IsolationSegmentsActor ¶
type IsolationSegmentsActor interface {
CloudControllerAPIVersion() string
GetIsolationSegmentSummaries() ([]v3action.IsolationSegmentSummary, v3action.Warnings, error)
}
type IsolationSegmentsCommand ¶
type IsolationSegmentsCommand struct {
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor IsolationSegmentsActor
// contains filtered or unexported fields
}
type ManifestParser ¶
type ManifestParser interface {
v3action.ManifestParser
Parse(manifestPath string) error
}
type NetworkPoliciesActor ¶
type NetworkPoliciesActor interface {
NetworkPoliciesBySpaceAndAppName(spaceGUID string, srcAppName string) ([]cfnetworkingaction.Policy, cfnetworkingaction.Warnings, error)
NetworkPoliciesBySpace(spaceGUID string) ([]cfnetworkingaction.Policy, cfnetworkingaction.Warnings, error)
}
type NetworkPoliciesCommand ¶
type NetworkPoliciesCommand struct {
SourceApp string `long:"source" required:"false" description:"Source app to filter results by"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor NetworkPoliciesActor
// contains filtered or unexported fields
}
type RemoveNetworkPolicyActor ¶
type RemoveNetworkPolicyActor interface {
RemoveNetworkPolicy(spaceGUID string, srcAppName string, destAppName string, protocol string, startPort int, endPort int) (cfnetworkingaction.Warnings, error)
}
type RemoveNetworkPolicyCommand ¶
type RemoveNetworkPolicyCommand struct {
RequiredArgs flag.RemoveNetworkPolicyArgs `positional-args:"yes"`
DestinationApp string `long:"destination-app" required:"true" description:"Name of app to connect to"`
Port flag.NetworkPort `long:"port" required:"true" description:"Port or range of ports that destination app is connected with"`
Protocol flag.NetworkProtocol `long:"protocol" required:"true" description:"Protocol that apps are connected with"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor RemoveNetworkPolicyActor
// contains filtered or unexported fields
}
type ResetOrgDefaultIsolationSegmentActor ¶
type ResetOrgDefaultIsolationSegmentActor interface {
CloudControllerAPIVersion() string
ResetOrganizationDefaultIsolationSegment(orgGUID string) (v3action.Warnings, error)
}
type ResetOrgDefaultIsolationSegmentActorV2 ¶
type ResetOrgDefaultIsolationSegmentActorV2 interface {
GetOrganizationByName(orgName string) (v2action.Organization, v2action.Warnings, error)
}
type ResetOrgDefaultIsolationSegmentCommand ¶
type ResetOrgDefaultIsolationSegmentCommand struct {
RequiredArgs flag.ResetOrgDefaultIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor ResetOrgDefaultIsolationSegmentActor
ActorV2 ResetOrgDefaultIsolationSegmentActorV2
// contains filtered or unexported fields
}
type ResetSpaceIsolationSegmentActor ¶
type ResetSpaceIsolationSegmentActor interface {
CloudControllerAPIVersion() string
ResetSpaceIsolationSegment(orgGUID string, spaceGUID string) (string, v3action.Warnings, error)
}
type ResetSpaceIsolationSegmentActorV2 ¶
type ResetSpaceIsolationSegmentActorV2 interface {
GetSpaceByOrganizationAndName(orgGUID string, spaceName string) (v2action.Space, v2action.Warnings, error)
}
type ResetSpaceIsolationSegmentCommand ¶
type ResetSpaceIsolationSegmentCommand struct {
RequiredArgs flag.ResetSpaceIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor ResetSpaceIsolationSegmentActor
ActorV2 ResetSpaceIsolationSegmentActorV2
// contains filtered or unexported fields
}
type RunTaskActor ¶
type RunTaskActor interface {
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
RunTask(appGUID string, task v3action.Task) (v3action.Task, v3action.Warnings, error)
CloudControllerAPIVersion() string
}
type RunTaskCommand ¶
type RunTaskCommand struct {
RequiredArgs flag.RunTaskArgs `positional-args:"yes"`
Disk 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)"`
Name string `long:"name" description:"Name to give the task (generated if omitted)"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor RunTaskActor
// contains filtered or unexported fields
}
type SSHActor ¶
type SSHActor interface {
ExecuteSecureShell(sshClient sharedaction.SecureShellClient, sshOptions sharedaction.SSHOptions) error
}
type SetOrgDefaultIsolationSegmentActor ¶
type SetOrgDefaultIsolationSegmentActor interface {
CloudControllerAPIVersion() string
GetIsolationSegmentByName(isoSegName string) (v3action.IsolationSegment, v3action.Warnings, error)
SetOrganizationDefaultIsolationSegment(orgGUID string, isoSegGUID string) (v3action.Warnings, error)
}
type SetOrgDefaultIsolationSegmentActorV2 ¶
type SetOrgDefaultIsolationSegmentActorV2 interface {
GetOrganizationByName(orgName string) (v2action.Organization, v2action.Warnings, error)
}
type SetOrgDefaultIsolationSegmentCommand ¶
type SetOrgDefaultIsolationSegmentCommand struct {
RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor SetOrgDefaultIsolationSegmentActor
ActorV2 SetOrgDefaultIsolationSegmentActorV2
// contains filtered or unexported fields
}
type SetSpaceIsolationSegmentActor ¶
type SetSpaceIsolationSegmentActor interface {
CloudControllerAPIVersion() string
AssignIsolationSegmentToSpaceByNameAndSpace(isolationSegmentName string, spaceGUID string) (v3action.Warnings, error)
}
type SetSpaceIsolationSegmentActorV2 ¶
type SetSpaceIsolationSegmentActorV2 interface {
GetSpaceByOrganizationAndName(orgGUID string, spaceName string) (v2action.Space, v2action.Warnings, error)
}
type SetSpaceIsolationSegmentCommand ¶
type SetSpaceIsolationSegmentCommand struct {
RequiredArgs flag.SpaceIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor SetSpaceIsolationSegmentActor
ActorV2 SetSpaceIsolationSegmentActorV2
// contains filtered or unexported fields
}
type ShareServiceActor ¶
type ShareServiceActor interface {
ShareServiceInstanceToSpaceNameByNameAndSpaceAndOrganizationName(sharedToSpaceName string, serviceInstanceName string, sourceSpaceGUID string, sharedToOrgName string) (v2v3action.Warnings, error)
ShareServiceInstanceToSpaceNameByNameAndSpaceAndOrganization(sharedToSpaceName string, serviceInstanceName string, sourceSpaceGUID string, sharedToOrgGUID string) (v2v3action.Warnings, error)
CloudControllerV3APIVersion() string
}
type ShareServiceCommand ¶
type ShareServiceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
OrgName string `short:"o" required:"false" description:"Org of the other space (Default: targeted org)"`
SpaceName string `short:"s" required:"true" description:"Space to share the service instance into"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor ShareServiceActor
// contains filtered or unexported fields
}
type TasksActor ¶
type TasksActor interface {
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
GetApplicationTasks(appGUID string, sortOrder v3action.SortOrder) ([]v3action.Task, v3action.Warnings, error)
CloudControllerAPIVersion() string
}
type TasksCommand ¶
type TasksCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor TasksActor
// contains filtered or unexported fields
}
type TerminateTaskActor ¶
type TerminateTaskActor interface {
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
GetTaskBySequenceIDAndApplication(sequenceID int, appGUID string) (v3action.Task, v3action.Warnings, error)
TerminateTask(taskGUID string) (v3action.Task, v3action.Warnings, error)
CloudControllerAPIVersion() string
}
type TerminateTaskCommand ¶
type TerminateTaskCommand struct {
RequiredArgs flag.TerminateTaskArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor TerminateTaskActor
// contains filtered or unexported fields
}
type UnshareServiceActor ¶
type UnshareServiceActor interface {
UnshareServiceInstanceFromOrganizationNameAndSpaceNameByNameAndSpace(sharedToOrgName string, sharedToSpaceName string, serviceInstanceName string, currentlyTargetedSpaceGUID string) (v2v3action.Warnings, error)
CloudControllerV3APIVersion() string
}
type UnshareServiceCommand ¶
type UnshareServiceCommand struct {
RequiredArgs flag.ServiceInstance `positional-args:"yes"`
SharedToOrgName string `short:"o" required:"false" description:"Org of the other space (Default: targeted org)"`
SharedToSpaceName string `short:"s" required:"true" description:"Space to unshare the service instance from"`
Force bool `short:"f" description:"Force unshare without confirmation"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor UnshareServiceActor
// contains filtered or unexported fields
}
type V2PushActor ¶
type V2PushActor interface {
CreateAndMapDefaultApplicationRoute(orgGUID string, spaceGUID string, app v2action.Application) (pushaction.Warnings, error)
}
type V3AppActor ¶
type V3AppActor interface {
shared.V3AppSummaryActor
CloudControllerAPIVersion() string
GetApplicationByNameAndSpace(name string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
}
type V3AppCommand ¶
type V3AppCommand 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 V3AppActor
AppSummaryDisplayer shared.AppSummaryDisplayer
// contains filtered or unexported fields
}
type V3ApplyManifestActor ¶
type V3ApplyManifestActor interface {
CloudControllerAPIVersion() string
ApplyApplicationManifest(parser v3action.ManifestParser, spaceGUID string) (v3action.Warnings, error)
}
type V3ApplyManifestCommand ¶
type V3ApplyManifestCommand struct {
PathToManifest flag.PathWithExistenceCheck `short:"f" description:"Path to app manifest" required:"true"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3ApplyManifestActor
Parser ManifestParser
// contains filtered or unexported fields
}
type V3AppsActor ¶
type V3AppsActor interface {
CloudControllerAPIVersion() string
GetApplicationsWithProcessesBySpace(spaceGUID string) ([]v3action.ApplicationWithProcessSummary, v3action.Warnings, error)
}
type V3AppsCommand ¶
type V3AppsCommand struct {
UI command.UI
Config command.Config
Actor V3AppsActor
V2AppRouteActor shared.V2AppRouteActor
SharedActor command.SharedActor
// contains filtered or unexported fields
}
type V3CreateAppActor ¶
type V3CreateAppActor interface {
CloudControllerAPIVersion() string
CreateApplicationInSpace(app v3action.Application, spaceGUID string) (v3action.Application, v3action.Warnings, error)
}
type V3CreateAppCommand ¶
type V3CreateAppCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
AppType flag.AppType `` /* 128-byte string literal not displayed */
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3CreateAppActor
// contains filtered or unexported fields
}
type V3CreatePackageActor ¶
type V3CreatePackageActor interface {
CloudControllerAPIVersion() string
CreateDockerPackageByApplicationNameAndSpace(appName string, spaceGUID string, dockerImageCredentials v3action.DockerImageCredentials) (v3action.Package, v3action.Warnings, error)
CreateAndUploadBitsPackageByApplicationNameAndSpace(appName string, spaceGUID string, bitsPath string) (v3action.Package, v3action.Warnings, error)
}
type V3CreatePackageCommand ¶
type V3CreatePackageCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
DockerImage flag.DockerImage `long:"docker-image" short:"o" description:"Docker image to use (e.g. user/docker-image-name)"`
AppPath flag.PathWithExistenceCheck `short:"p" description:"Path to app directory or to a zip file of the contents of the app directory"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3CreatePackageActor
PackageDisplayer shared.PackageDisplayer
// contains filtered or unexported fields
}
type V3DeleteActor ¶
type V3DeleteActor interface {
CloudControllerAPIVersion() string
DeleteApplicationByNameAndSpace(name string, spaceGUID string) (v3action.Warnings, error)
}
type V3DeleteCommand ¶
type V3DeleteCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
Force bool `short:"f" description:"Force deletion without confirmation"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3DeleteActor
// contains filtered or unexported fields
}
type V3DropletsActor ¶
type V3DropletsActor interface {
CloudControllerAPIVersion() string
GetApplicationDroplets(appName string, spaceGUID string) ([]v3action.Droplet, v3action.Warnings, error)
}
type V3DropletsCommand ¶
type V3DropletsCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3DropletsActor
SharedActor command.SharedActor
// contains filtered or unexported fields
}
type V3EnvActor ¶
type V3EnvActor interface {
CloudControllerAPIVersion() string
GetEnvironmentVariablesByApplicationNameAndSpace(appName string, spaceGUID string) (v3action.EnvironmentVariableGroups, v3action.Warnings, error)
}
type V3EnvCommand ¶
type V3EnvCommand struct {
RequiredArgs flag.EnvironmentArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3EnvActor
// contains filtered or unexported fields
}
type V3GetHealthCheckActor ¶
type V3GetHealthCheckActor interface {
CloudControllerAPIVersion() string
GetApplicationProcessHealthChecksByNameAndSpace(appName string, spaceGUID string) ([]v3action.ProcessHealthCheck, v3action.Warnings, error)
}
type V3GetHealthCheckCommand ¶
type V3GetHealthCheckCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3GetHealthCheckActor
// contains filtered or unexported fields
}
type V3PackagesActor ¶
type V3PackagesActor interface {
CloudControllerAPIVersion() string
GetApplicationPackages(appName string, spaceGUID string) ([]v3action.Package, v3action.Warnings, error)
}
type V3PackagesCommand ¶
type V3PackagesCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3PackagesActor
SharedActor command.SharedActor
// contains filtered or unexported fields
}
type V3PushActor ¶
type V3PushActor interface {
CloudControllerAPIVersion() string
CreateAndUploadBitsPackageByApplicationNameAndSpace(appName string, spaceGUID string, bitsPath string) (v3action.Package, v3action.Warnings, error)
CreateDockerPackageByApplicationNameAndSpace(appName string, spaceGUID string, dockerImageCredentials v3action.DockerImageCredentials) (v3action.Package, v3action.Warnings, error)
CreateApplicationInSpace(app v3action.Application, spaceGUID string) (v3action.Application, v3action.Warnings, error)
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
GetApplicationSummaryByNameAndSpace(appName string, spaceGUID string) (v3action.ApplicationSummary, v3action.Warnings, error)
GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client v3action.NOAAClient) (<-chan *v3action.LogMessage, <-chan error, v3action.Warnings, error)
PollStart(appGUID string, warnings chan<- v3action.Warnings) error
SetApplicationDroplet(appName string, spaceGUID string, dropletGUID string) (v3action.Warnings, error)
StagePackage(packageGUID string, appName string) (<-chan v3action.Droplet, <-chan v3action.Warnings, <-chan error)
StartApplication(appGUID string) (v3action.Application, v3action.Warnings, error)
StopApplication(appGUID string) (v3action.Warnings, error)
UpdateApplication(app v3action.Application) (v3action.Application, v3action.Warnings, error)
}
type V3PushCommand ¶
type V3PushCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
Buildpacks []string `` /* 317-byte string literal not displayed */
DockerImage flag.DockerImage `long:"docker-image" short:"o" description:"Docker image to use (e.g. user/docker-image-name)"`
DockerUsername string `long:"docker-username" description:"Repository username; used with password from environment variable CF_DOCKER_PASSWORD"`
NoRoute bool `long:"no-route" description:"Do not map a route to this app"`
NoStart bool `long:"no-start" description:"Do not stage and start the 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"`
UI command.UI
Config command.Config
NOAAClient v3action.NOAAClient
SharedActor command.SharedActor
Actor V3PushActor
V2PushActor V2PushActor
AppSummaryDisplayer shared.AppSummaryDisplayer
PackageDisplayer shared.PackageDisplayer
// contains filtered or unexported fields
}
type V3RestartActor ¶
type V3RestartActor interface {
CloudControllerAPIVersion() string
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
StartApplication(appGUID string) (v3action.Application, v3action.Warnings, error)
StopApplication(appGUID string) (v3action.Warnings, error)
}
type V3RestartAppInstanceActor ¶
type V3RestartAppInstanceActor interface {
CloudControllerAPIVersion() string
DeleteInstanceByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, instanceIndex int) (v3action.Warnings, error)
}
type V3RestartAppInstanceCommand ¶
type V3RestartAppInstanceCommand struct {
RequiredArgs flag.AppInstance `positional-args:"yes"`
ProcessType string `long:"process" default:"web" description:"Process to restart"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3RestartAppInstanceActor
// contains filtered or unexported fields
}
type V3RestartCommand ¶
type V3RestartCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3RestartActor
// contains filtered or unexported fields
}
type V3SSHActor ¶
type V3SSHActor interface {
CloudControllerAPIVersion() string
GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, processIndex uint) (v3action.SSHAuthentication, v3action.Warnings, error)
}
type V3SSHCommand ¶
type V3SSHCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
ProcessIndex uint `long:"app-instance-index" short:"i" description:"App process instance index (Default: 0)"`
Commands []string `long:"command" short:"c" description:"Command to run"`
DisablePseudoTTY bool `long:"disable-pseudo-tty" short:"T" description:"Disable pseudo-tty allocation"`
ForcePseudoTTY bool `long:"force-pseudo-tty" description:"Force pseudo-tty allocation"`
LocalPortForwardSpecs []flag.SSHPortForwarding `short:"L" description:"Local port forward specification"`
ProcessType string `long:"process" description:"App process name (Default: web)"`
RequestPseudoTTY 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. Not recommended!"`
SkipRemoteExecution bool `long:"skip-remote-execution" short:"N" description:"Do not execute a remote command"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3SSHActor
SSHActor SSHActor
SSHClient *clissh.SecureShell
// contains filtered or unexported fields
}
func (V3SSHCommand) EvaluateTTYOption ¶
func (cmd V3SSHCommand) EvaluateTTYOption() (sharedaction.TTYOption, error)
EvaluateTTYOption determines which TTY options are mutually exclusive and returns an error accordingly.
type V3ScaleActor ¶
type V3ScaleActor interface {
shared.V3AppSummaryActor
CloudControllerAPIVersion() string
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
ScaleProcessByApplication(appGUID string, process v3action.Process) (v3action.Warnings, error)
StopApplication(appGUID string) (v3action.Warnings, error)
StartApplication(appGUID string) (v3action.Application, v3action.Warnings, error)
PollStart(appGUID string, warnings chan<- v3action.Warnings) error
}
type V3ScaleCommand ¶
type V3ScaleCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
Force bool `short:"f" description:"Force restart of app without prompt"`
Instances flag.Instances `short:"i" required:"false" description:"Number of instances"`
DiskLimit flag.Megabytes `short:"k" required:"false" description:"Disk limit (e.g. 256M, 1024M, 1G)"`
MemoryLimit flag.Megabytes `short:"m" required:"false" description:"Memory limit (e.g. 256M, 1024M, 1G)"`
ProcessType string `long:"process" default:"web" description:"App process to scale"`
UI command.UI
Config command.Config
Actor V3ScaleActor
SharedActor command.SharedActor
AppSummaryDisplayer shared.AppSummaryDisplayer
// contains filtered or unexported fields
}
type V3SetDropletActor ¶
type V3SetDropletActor interface {
CloudControllerAPIVersion() string
SetApplicationDroplet(appName string, spaceGUID string, dropletGUID string) (v3action.Warnings, error)
}
type V3SetDropletCommand ¶
type V3SetDropletCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
DropletGUID string `short:"d" long:"droplet-guid" description:"The guid of the droplet to use" required:"true"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3SetDropletActor
// contains filtered or unexported fields
}
type V3SetEnvActor ¶
type V3SetEnvActor interface {
CloudControllerAPIVersion() string
SetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, envPair v3action.EnvironmentVariablePair) (v3action.Warnings, error)
}
type V3SetEnvCommand ¶
type V3SetEnvCommand struct {
RequiredArgs flag.SetEnvironmentArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3SetEnvActor
// contains filtered or unexported fields
}
type V3SetHealthCheckActor ¶
type V3SetHealthCheckActor interface {
CloudControllerAPIVersion() string
SetApplicationProcessHealthCheckTypeByNameAndSpace(appName string, spaceGUID string, healthCheckType string, httpEndpoint string, processType string) (v3action.Application, v3action.Warnings, error)
}
type V3SetHealthCheckCommand ¶
type V3SetHealthCheckCommand struct {
RequiredArgs flag.SetHealthCheckArgs `positional-args:"yes"`
HTTPEndpoint string `long:"endpoint" default:"/" description:"Path on the app"`
ProcessType string `long:"process" default:"web" description:"App process to update"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3SetHealthCheckActor
// contains filtered or unexported fields
}
type V3StageActor ¶
type V3StageActor interface {
CloudControllerAPIVersion() string
GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client v3action.NOAAClient) (<-chan *v3action.LogMessage, <-chan error, v3action.Warnings, error)
StagePackage(packageGUID string, appName string) (<-chan v3action.Droplet, <-chan v3action.Warnings, <-chan error)
}
type V3StageCommand ¶
type V3StageCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
PackageGUID string `long:"package-guid" description:"The guid of the package to stage" required:"true"`
UI command.UI
Config command.Config
NOAAClient v3action.NOAAClient
SharedActor command.SharedActor
Actor V3StageActor
// contains filtered or unexported fields
}
type V3StartActor ¶
type V3StartActor interface {
CloudControllerAPIVersion() string
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
StartApplication(appGUID string) (v3action.Application, v3action.Warnings, error)
}
type V3StartCommand ¶
type V3StartCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3StartActor
// contains filtered or unexported fields
}
type V3StopActor ¶
type V3StopActor interface {
CloudControllerAPIVersion() string
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
StopApplication(appGUID string) (v3action.Warnings, error)
}
type V3StopCommand ¶
type V3StopCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3StopActor
// contains filtered or unexported fields
}
type V3UnsetEnvActor ¶
type V3UnsetEnvActor interface {
CloudControllerAPIVersion() string
UnsetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, EnvironmentVariableName string) (v3action.Warnings, error)
}
type V3UnsetEnvCommand ¶
type V3UnsetEnvCommand struct {
RequiredArgs flag.UnsetEnvironmentArgs `positional-args:"yes"`
UI command.UI
Config command.Config
SharedActor command.SharedActor
Actor V3UnsetEnvActor
// contains filtered or unexported fields
}
Source Files
¶
- add_network_policy_command.go
- create_isolation_segment_command.go
- delete_isolation_segment_command.go
- disable_org_isolation_command.go
- enable_org_isolation_command.go
- godoc.go
- isolation_segments_command.go
- network_policies_command.go
- remove_network_policy_command.go
- reset_org_default_isolation_segment_command.go
- reset_space_isolation_segment_command.go
- run_task_command.go
- set_org_default_isolation_segment_command.go
- set_space_isolation_segment_command.go
- share_service_command.go
- tasks_command.go
- terminate_task_command.go
- unshare_service_command.go
- v3_app_command.go
- v3_apply_manifest_command.go
- v3_apps_command.go
- v3_create_app_command.go
- v3_create_package_command.go
- v3_delete_command.go
- v3_droplets_command.go
- v3_env_command.go
- v3_get_health_check_command.go
- v3_packages_command.go
- v3_push_command.go
- v3_restart_app_instance_command.go
- v3_restart_command.go
- v3_scale_command.go
- v3_set_droplet_command.go
- v3_set_env_command.go
- v3_set_health_check_command.go
- v3_ssh_command.go
- v3_stage_command.go
- v3_start_command.go
- v3_stop_command.go
- v3_unset_env_command.go
Directories
¶
Path | Synopsis |
---|---|
Package shared should not be imported by external consumers.
|
Package shared should not be imported by external consumers. |
sharedfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
Click to show internal directories.
Click to hide internal directories.