Documentation
¶
Overview ¶
Package v3 should not be imported by external consumers. It was not designed for external use.
Index ¶
- type CreateIsolationSegmentActor
- type CreateIsolationSegmentCommand
- type DeleteIsolationSegmentActor
- type DeleteIsolationSegmentCommand
- type DisableOrgIsolationActor
- type DisableOrgIsolationCommand
- type EnableOrgIsolationActor
- type EnableOrgIsolationCommand
- type IsolationSegmentsActor
- type IsolationSegmentsCommand
- type ResetOrgDefaultIsolationSegmentActor
- type ResetOrgDefaultIsolationSegmentActorV2
- type ResetOrgDefaultIsolationSegmentCommand
- type ResetSpaceIsolationSegmentActor
- type ResetSpaceIsolationSegmentActorV2
- type ResetSpaceIsolationSegmentCommand
- type RunTaskActor
- type RunTaskCommand
- type SetOrgDefaultIsolationSegmentActor
- type SetOrgDefaultIsolationSegmentActorV2
- type SetOrgDefaultIsolationSegmentCommand
- type SetSpaceIsolationSegmentActor
- type SetSpaceIsolationSegmentActorV2
- type SetSpaceIsolationSegmentCommand
- type TasksActor
- type TasksCommand
- type TerminateTaskActor
- type TerminateTaskCommand
- type V2PushActor
- type V3AppActor
- type V3AppCommand
- type V3AppsActor
- type V3AppsCommand
- type V3CreateAppActor
- type V3CreateAppCommand
- type V3CreatePackageActor
- type V3CreatePackageCommand
- type V3DeleteActor
- type V3DeleteCommand
- type V3DropletsActor
- type V3DropletsCommand
- type V3GetHealthCheckActor
- type V3GetHealthCheckCommand
- type V3PackagesActor
- type V3PackagesCommand
- type V3PushActor
- type V3PushCommand
- type V3RestartActor
- type V3RestartAppInstanceActor
- type V3RestartAppInstanceCommand
- type V3RestartCommand
- type V3ScaleActor
- type V3ScaleCommand
- type V3SetDropletActor
- type V3SetDropletCommand
- type V3SetHealthCheckActor
- type V3SetHealthCheckCommand
- type V3StageActor
- type V3StageCommand
- type V3StartActor
- type V3StartCommand
- type V3StopActor
- type V3StopCommand
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateIsolationSegmentCommand ¶
type CreateIsolationSegmentCommand struct {
RequiredArgs flag.IsolationSegmentName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor CreateIsolationSegmentActor
// contains filtered or unexported fields
}
func (CreateIsolationSegmentCommand) Execute ¶
func (cmd CreateIsolationSegmentCommand) Execute(args []string) 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
Actor DeleteIsolationSegmentActor
// contains filtered or unexported fields
}
func (DeleteIsolationSegmentCommand) Execute ¶
func (cmd DeleteIsolationSegmentCommand) Execute(args []string) error
type DisableOrgIsolationCommand ¶
type DisableOrgIsolationCommand struct {
RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
Actor DisableOrgIsolationActor
// contains filtered or unexported fields
}
func (DisableOrgIsolationCommand) Execute ¶
func (cmd DisableOrgIsolationCommand) Execute(args []string) error
type EnableOrgIsolationActor ¶
type EnableOrgIsolationCommand ¶
type EnableOrgIsolationCommand struct {
RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
Actor EnableOrgIsolationActor
// contains filtered or unexported fields
}
func (EnableOrgIsolationCommand) Execute ¶
func (cmd EnableOrgIsolationCommand) Execute(args []string) error
type IsolationSegmentsActor ¶
type IsolationSegmentsCommand ¶
type IsolationSegmentsCommand struct {
UI command.UI
Config command.Config
Actor IsolationSegmentsActor
// contains filtered or unexported fields
}
func (IsolationSegmentsCommand) Execute ¶
func (cmd IsolationSegmentsCommand) Execute(args []string) error
type ResetOrgDefaultIsolationSegmentCommand ¶
type ResetOrgDefaultIsolationSegmentCommand struct {
RequiredArgs flag.ResetOrgDefaultIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
Actor ResetOrgDefaultIsolationSegmentActor
ActorV2 ResetOrgDefaultIsolationSegmentActorV2
// contains filtered or unexported fields
}
func (ResetOrgDefaultIsolationSegmentCommand) Execute ¶
func (cmd ResetOrgDefaultIsolationSegmentCommand) Execute(args []string) error
type ResetSpaceIsolationSegmentCommand ¶
type ResetSpaceIsolationSegmentCommand struct {
RequiredArgs flag.ResetSpaceIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
Actor ResetSpaceIsolationSegmentActor
ActorV2 ResetSpaceIsolationSegmentActorV2
// contains filtered or unexported fields
}
func (ResetSpaceIsolationSegmentCommand) Execute ¶
func (cmd ResetSpaceIsolationSegmentCommand) Execute(args []string) error
type RunTaskActor ¶
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
Actor RunTaskActor
// contains filtered or unexported fields
}
func (RunTaskCommand) Execute ¶
func (cmd RunTaskCommand) Execute(args []string) error
type SetOrgDefaultIsolationSegmentCommand ¶
type SetOrgDefaultIsolationSegmentCommand struct {
RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
Actor SetOrgDefaultIsolationSegmentActor
ActorV2 SetOrgDefaultIsolationSegmentActorV2
// contains filtered or unexported fields
}
func (SetOrgDefaultIsolationSegmentCommand) Execute ¶
func (cmd SetOrgDefaultIsolationSegmentCommand) Execute(args []string) error
type SetSpaceIsolationSegmentCommand ¶
type SetSpaceIsolationSegmentCommand struct {
RequiredArgs flag.SpaceIsolationArgs `positional-args:"yes"`
UI command.UI
Config command.Config
Actor SetSpaceIsolationSegmentActor
ActorV2 SetSpaceIsolationSegmentActorV2
// contains filtered or unexported fields
}
func (SetSpaceIsolationSegmentCommand) Execute ¶
func (cmd SetSpaceIsolationSegmentCommand) Execute(args []string) error
type TasksActor ¶
type TasksCommand ¶
type TasksCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor TasksActor
// contains filtered or unexported fields
}
func (TasksCommand) Execute ¶
func (cmd TasksCommand) Execute(args []string) error
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
Actor TerminateTaskActor
// contains filtered or unexported fields
}
func (TerminateTaskCommand) Execute ¶
func (cmd TerminateTaskCommand) Execute(args []string) error
type V2PushActor ¶
type V2PushActor interface {
CreateAndBindApplicationRoutes(orgGUID string, spaceGUID string, app v2action.Application) (pushaction.Warnings, error)
}
type V3AppActor ¶
type V3AppActor interface {
shared.V3AppSummaryActor
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
Actor V3AppActor
AppSummaryDisplayer shared.AppSummaryDisplayer
// contains filtered or unexported fields
}
func (V3AppCommand) Execute ¶
func (cmd V3AppCommand) Execute(args []string) error
type V3AppsActor ¶
type V3AppsCommand ¶
type V3AppsCommand struct {
UI command.UI
Config command.Config
Actor V3AppsActor
V2AppRouteActor shared.V2AppRouteActor
// contains filtered or unexported fields
}
func (V3AppsCommand) Execute ¶
func (cmd V3AppsCommand) Execute(args []string) error
type V3CreateAppActor ¶
type V3CreateAppActor interface {
CreateApplicationByNameAndSpace(createApplicationInput v3action.CreateApplicationInput) (v3action.Application, v3action.Warnings, error)
}
type V3CreateAppCommand ¶
type V3CreateAppCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3CreateAppActor
// contains filtered or unexported fields
}
func (V3CreateAppCommand) Execute ¶
func (cmd V3CreateAppCommand) Execute(args []string) error
type V3CreatePackageActor ¶
type V3CreatePackageCommand ¶
type V3CreatePackageCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3CreatePackageActor
// contains filtered or unexported fields
}
func (V3CreatePackageCommand) Execute ¶
func (cmd V3CreatePackageCommand) Execute(args []string) error
type V3DeleteActor ¶
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
Actor V3DeleteActor
// contains filtered or unexported fields
}
func (V3DeleteCommand) Execute ¶
func (cmd V3DeleteCommand) Execute(args []string) error
type V3DropletsActor ¶
type V3DropletsCommand ¶
type V3DropletsCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3DropletsActor
// contains filtered or unexported fields
}
func (V3DropletsCommand) Execute ¶
func (cmd V3DropletsCommand) Execute(args []string) error
type V3GetHealthCheckActor ¶
type V3GetHealthCheckCommand ¶
type V3GetHealthCheckCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3GetHealthCheckActor
// contains filtered or unexported fields
}
func (V3GetHealthCheckCommand) Execute ¶
func (cmd V3GetHealthCheckCommand) Execute(args []string) error
type V3PackagesActor ¶
type V3PackagesCommand ¶
type V3PackagesCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3PackagesActor
// contains filtered or unexported fields
}
func (V3PackagesCommand) Execute ¶
func (cmd V3PackagesCommand) Execute(args []string) error
type V3PushActor ¶
type V3PushActor interface {
CreateAndUploadPackageByApplicationNameAndSpace(appName string, spaceGUID string, bitsPath string) (v3action.Package, v3action.Warnings, error)
CreateApplicationByNameAndSpace(createApplicationInput v3action.CreateApplicationInput) (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.Build, <-chan v3action.Warnings, <-chan error)
StartApplication(appGUID string) (v3action.Application, v3action.Warnings, error)
StopApplication(appGUID string) (v3action.Warnings, error)
UpdateApplication(appGUID string, buildpacks []string) (v3action.Application, v3action.Warnings, error)
}
type V3PushCommand ¶
type V3PushCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
NoRoute bool `long:"no-route" description:"Do not map a route to this app"`
Buildpacks []string `` /* 317-byte string literal not displayed */
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
Actor V3PushActor
V2PushActor V2PushActor
AppSummaryDisplayer shared.AppSummaryDisplayer
// contains filtered or unexported fields
}
func (V3PushCommand) Execute ¶
func (cmd V3PushCommand) Execute(args []string) error
type V3RestartActor ¶
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
Actor V3RestartAppInstanceActor
// contains filtered or unexported fields
}
func (V3RestartAppInstanceCommand) Execute ¶
func (cmd V3RestartAppInstanceCommand) Execute(args []string) error
type V3RestartCommand ¶
type V3RestartCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3RestartActor
// contains filtered or unexported fields
}
func (V3RestartCommand) Execute ¶
func (cmd V3RestartCommand) Execute(args []string) error
type V3ScaleActor ¶
type V3ScaleActor interface {
shared.V3AppSummaryActor
GetApplicationByNameAndSpace(appName string, spaceGUID string) (v3action.Application, v3action.Warnings, error)
GetProcessSummaryByApplicationAndProcessType(appGUID string, processType string) (v3action.ProcessSummary, 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"`
ProcessType string `long:"process" default:"web" description:"App process to scale"`
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)"`
UI command.UI
Config command.Config
Actor V3ScaleActor
AppSummaryDisplayer shared.AppSummaryDisplayer
// contains filtered or unexported fields
}
func (V3ScaleCommand) Execute ¶
func (cmd V3ScaleCommand) Execute(args []string) error
type V3SetDropletActor ¶
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
Actor V3SetDropletActor
// contains filtered or unexported fields
}
func (V3SetDropletCommand) Execute ¶
func (cmd V3SetDropletCommand) Execute(args []string) error
type V3SetHealthCheckActor ¶
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
Actor V3SetHealthCheckActor
// contains filtered or unexported fields
}
func (V3SetHealthCheckCommand) Execute ¶
func (cmd V3SetHealthCheckCommand) Execute(args []string) error
type V3StageActor ¶
type V3StageActor interface {
GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client v3action.NOAAClient) (<-chan *v3action.LogMessage, <-chan error, v3action.Warnings, error)
StagePackage(packageGUID string, appName string) (<-chan v3action.Build, <-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
Actor V3StageActor
// contains filtered or unexported fields
}
func (V3StageCommand) Execute ¶
func (cmd V3StageCommand) Execute(args []string) error
type V3StartActor ¶
type V3StartCommand ¶
type V3StartCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3StartActor
// contains filtered or unexported fields
}
func (V3StartCommand) Execute ¶
func (cmd V3StartCommand) Execute(args []string) error
type V3StopActor ¶
type V3StopCommand ¶
type V3StopCommand struct {
RequiredArgs flag.AppName `positional-args:"yes"`
UI command.UI
Config command.Config
Actor V3StopActor
// contains filtered or unexported fields
}
func (V3StopCommand) Execute ¶
func (cmd V3StopCommand) Execute(args []string) error
Source Files
¶
- 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
- 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
- tasks_command.go
- terminate_task_command.go
- v3_app_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_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_health_check_command.go
- v3_stage_command.go
- v3_start_command.go
- v3_stop_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.