v7

package
v6.52.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2020 License: Apache-2.0 Imports: 45 Imported by: 0

Documentation

Overview

Package v7 should not be imported by external consumers. It was not designed for external use.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APICommand

type APICommand struct {
	BaseCommand

	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"`
	// contains filtered or unexported fields
}

func (*APICommand) Execute

func (cmd *APICommand) Execute(args []string) error

func (*APICommand) Setup

func (cmd *APICommand) Setup(config command.Config, ui command.UI) error

type ActionType

type ActionType string
const (
	Unset ActionType = "Removing"
	Set   ActionType = "Setting"
)

type Actor

type Actor interface {
	ApplyOrganizationQuotaByName(quotaName string, orgGUID string) (v7action.Warnings, error)
	ApplySpaceQuotaByName(quotaName string, spaceGUID string, orgGUID string) (v7action.Warnings, error)
	AssignIsolationSegmentToSpaceByNameAndSpace(isolationSegmentName string, spaceGUID string) (v7action.Warnings, error)
	Authenticate(credentials map[string]string, origin string, grantType uaa.GrantType) error
	BindSecurityGroupToSpaces(securityGroupGUID string, spaces []v7action.Space, lifecycle constant.SecurityGroupLifecycle) (v7action.Warnings, error)
	CancelDeployment(deploymentGUID string) (v7action.Warnings, error)
	CheckRoute(domainName string, hostname string, path string) (bool, v7action.Warnings, error)
	ClearTarget()
	CloudControllerAPIVersion() string
	CopyPackage(sourceApp resources.Application, targetApp resources.Application) (v7action.Package, v7action.Warnings, error)
	CreateAndUploadBitsPackageByApplicationNameAndSpace(appName string, spaceGUID string, bitsPath string) (v7action.Package, v7action.Warnings, error)
	CreateApplicationDroplet(appGUID string) (resources.Droplet, v7action.Warnings, error)
	CreateApplicationInSpace(app resources.Application, spaceGUID string) (resources.Application, v7action.Warnings, error)
	CreateBitsPackageByApplication(appGUID string) (v7action.Package, v7action.Warnings, error)
	CreateBuildpack(buildpack v7action.Buildpack) (v7action.Buildpack, v7action.Warnings, error)
	CreateDeployment(appGUID string, dropletGUID string) (string, v7action.Warnings, error)
	CreateDockerPackageByApplication(appGUID string, dockerImageCredentials v7action.DockerImageCredentials) (v7action.Package, v7action.Warnings, error)
	CreateDockerPackageByApplicationNameAndSpace(appName string, spaceGUID string, dockerImageCredentials v7action.DockerImageCredentials) (v7action.Package, v7action.Warnings, error)
	CreateIsolationSegmentByName(isolationSegment v7action.IsolationSegment) (v7action.Warnings, error)
	CreateOrgRole(roleType constant.RoleType, orgGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error)
	CreateOrganization(orgName string) (resources.Organization, v7action.Warnings, error)
	CreateOrganizationQuota(name string, limits v7action.QuotaLimits) (v7action.Warnings, error)
	CreatePrivateDomain(domainName string, orgName string) (v7action.Warnings, error)
	CreateRoute(spaceGUID, domainName, hostname, path string, port int) (resources.Route, v7action.Warnings, error)
	CreateSecurityGroup(name, filePath string) (v7action.Warnings, error)
	CreateServiceBroker(model v7action.ServiceBrokerModel) (v7action.Warnings, error)
	CreateSharedDomain(domainName string, internal bool, routerGroupName string) (v7action.Warnings, error)
	CreateSpace(spaceName, orgGUID string) (v7action.Space, v7action.Warnings, error)
	CreateSpaceQuota(spaceQuotaName string, orgGuid string, limits v7action.QuotaLimits) (v7action.Warnings, error)
	CreateSpaceRole(roleType constant.RoleType, orgGUID string, spaceGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error)
	CreateUser(username string, password string, origin string) (resources.User, v7action.Warnings, error)
	DeleteApplicationByNameAndSpace(name, spaceGUID string, deleteRoutes bool) (v7action.Warnings, error)
	DeleteBuildpackByNameAndStack(buildpackName string, buildpackStack string) (v7action.Warnings, error)
	DeleteDomain(domain resources.Domain) (v7action.Warnings, error)
	DeleteInstanceByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, instanceIndex int) (v7action.Warnings, error)
	DeleteOrgRole(roleType constant.RoleType, orgGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error)
	DeleteOrganization(orgName string) (v7action.Warnings, error)
	DeleteOrganizationQuota(quotaName string) (v7action.Warnings, error)
	DeleteOrphanedRoutes(spaceGUID string) (v7action.Warnings, error)
	DeleteRoute(domainName, hostname, path string) (v7action.Warnings, error)
	DeleteSecurityGroup(securityGroupName string) (v7action.Warnings, error)
	DeleteServiceBroker(serviceBrokerGUID string) (v7action.Warnings, error)
	DeleteSpaceByNameAndOrganizationName(spaceName string, orgName string) (v7action.Warnings, error)
	DeleteSpaceQuotaByName(quotaName string, orgGUID string) (v7action.Warnings, error)
	DeleteSpaceRole(roleType constant.RoleType, spaceGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error)
	DeleteUser(userGuid string) (v7action.Warnings, error)
	DeleteIsolationSegmentByName(name string) (v7action.Warnings, error)
	DeleteIsolationSegmentOrganizationByName(isolationSegmentName string, orgName string) (v7action.Warnings, error)
	DisableFeatureFlag(flagName string) (v7action.Warnings, error)
	DisableServiceAccess(offeringName, brokerName, orgName, planName string) (v7action.SkippedPlans, v7action.Warnings, error)
	EnableFeatureFlag(flagName string) (v7action.Warnings, error)
	EnableServiceAccess(offeringName, brokerName, orgName, planName string) (v7action.SkippedPlans, v7action.Warnings, error)
	EntitleIsolationSegmentToOrganizationByName(isolationSegmentName string, orgName string) (v7action.Warnings, error)
	GetAppFeature(appGUID string, featureName string) (ccv3.ApplicationFeature, v7action.Warnings, error)
	GetAppSummariesForSpace(spaceGUID string, labels string) ([]v7action.ApplicationSummary, v7action.Warnings, error)
	GetApplicationByNameAndSpace(appName string, spaceGUID string) (resources.Application, v7action.Warnings, error)
	GetApplicationDroplets(appName string, spaceGUID string) ([]resources.Droplet, v7action.Warnings, error)
	GetApplicationLabels(appName string, spaceGUID string) (map[string]types.NullString, v7action.Warnings, error)
	GetApplicationPackages(appName string, spaceGUID string) ([]v7action.Package, v7action.Warnings, error)
	GetApplicationProcessHealthChecksByNameAndSpace(appName string, spaceGUID string) ([]v7action.ProcessHealthCheck, v7action.Warnings, error)
	GetApplicationRoutes(appGUID string) ([]resources.Route, v7action.Warnings, error)
	GetApplicationTasks(appName string, sortOrder v7action.SortOrder) ([]v7action.Task, v7action.Warnings, error)
	GetApplicationsByNamesAndSpace(appNames []string, spaceGUID string) ([]resources.Application, v7action.Warnings, error)
	GetBuildpackLabels(buildpackName string, buildpackStack string) (map[string]types.NullString, v7action.Warnings, error)
	GetBuildpacks(labelSelector string) ([]v7action.Buildpack, v7action.Warnings, error)
	GetDefaultDomain(orgGUID string) (resources.Domain, v7action.Warnings, error)
	GetDetailedAppSummary(appName string, spaceGUID string, withObfuscatedValues bool) (v7action.DetailedApplicationSummary, v7action.Warnings, error)
	GetDomain(domainGUID string) (resources.Domain, v7action.Warnings, error)
	GetDomainByName(domainName string) (resources.Domain, v7action.Warnings, error)
	GetDomainLabels(domainName string) (map[string]types.NullString, v7action.Warnings, error)
	GetEffectiveIsolationSegmentBySpace(spaceGUID string, orgDefaultIsolationSegmentGUID string) (v7action.IsolationSegment, v7action.Warnings, error)
	GetEnvironmentVariableGroup(group constant.EnvironmentVariableGroupName) (v7action.EnvironmentVariableGroup, v7action.Warnings, error)
	GetEnvironmentVariablesByApplicationNameAndSpace(appName string, spaceGUID string) (v7action.EnvironmentVariableGroups, v7action.Warnings, error)
	GetFeatureFlagByName(featureFlagName string) (v7action.FeatureFlag, v7action.Warnings, error)
	GetFeatureFlags() ([]v7action.FeatureFlag, v7action.Warnings, error)
	GetGlobalRunningSecurityGroups() ([]resources.SecurityGroup, v7action.Warnings, error)
	GetGlobalStagingSecurityGroups() ([]resources.SecurityGroup, v7action.Warnings, error)
	GetIsolationSegmentsByOrganization(orgName string) ([]v7action.IsolationSegment, v7action.Warnings, error)
	GetIsolationSegmentByName(isoSegmentName string) (v7action.IsolationSegment, v7action.Warnings, error)
	GetIsolationSegmentSummaries() ([]v7action.IsolationSegmentSummary, v7action.Warnings, error)
	GetLatestActiveDeploymentForApp(appGUID string) (v7action.Deployment, v7action.Warnings, error)
	GetLogCacheEndpoint() (string, v7action.Warnings, error)
	GetLoginPrompts() map[string]coreconfig.AuthPrompt
	GetNewestReadyPackageForApplication(app resources.Application) (v7action.Package, v7action.Warnings, error)
	GetOrgUsersByRoleType(orgGUID string) (map[constant.RoleType][]resources.User, v7action.Warnings, error)
	GetOrganizationByName(orgName string) (resources.Organization, v7action.Warnings, error)
	GetOrganizationDomains(string, string) ([]resources.Domain, v7action.Warnings, error)
	GetOrganizationLabels(orgName string) (map[string]types.NullString, v7action.Warnings, error)
	GetOrganizationQuotaByName(orgQuotaName string) (resources.OrganizationQuota, v7action.Warnings, error)
	GetOrganizationQuotas() ([]resources.OrganizationQuota, v7action.Warnings, error)
	GetOrganizationSpaces(orgGUID string) ([]v7action.Space, v7action.Warnings, error)
	GetOrganizationSpacesWithLabelSelector(orgGUID string, labelSelector string) ([]v7action.Space, v7action.Warnings, error)
	GetOrganizationSummaryByName(orgName string) (v7action.OrganizationSummary, v7action.Warnings, error)
	GetOrganizations(labelSelector string) ([]resources.Organization, v7action.Warnings, error)
	GetProcessByTypeAndApplication(processType string, appGUID string) (v7action.Process, v7action.Warnings, error)
	GetRawApplicationManifestByNameAndSpace(appName string, spaceGUID string) ([]byte, v7action.Warnings, error)
	GetRecentEventsByApplicationNameAndSpace(appName string, spaceGUID string) ([]v7action.Event, v7action.Warnings, error)
	GetRecentLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client sharedaction.LogCacheClient) ([]sharedaction.LogMessage, v7action.Warnings, error)
	GetRouteByAttributes(domainName string, domainGUID string, hostname string, path string, port int) (resources.Route, v7action.Warnings, error)
	GetRouteDestinationByAppGUID(routeGUID string, appGUID string) (resources.RouteDestination, v7action.Warnings, error)
	GetRouteLabels(routeName string, spaceGUID string) (map[string]types.NullString, v7action.Warnings, error)
	GetRouterGroups() ([]v7action.RouterGroup, error)
	GetRouteSummaries([]resources.Route) ([]v7action.RouteSummary, v7action.Warnings, error)
	GetRoutesByOrg(orgGUID string, labels string) ([]resources.Route, v7action.Warnings, error)
	GetRoutesBySpace(spaceGUID string, labels string) ([]resources.Route, v7action.Warnings, error)
	GetSSHEnabled(appGUID string) (ccv3.SSHEnabled, v7action.Warnings, error)
	GetSSHEnabledByAppName(appName string, spaceGUID string) (ccv3.SSHEnabled, v7action.Warnings, error)
	GetSSHPasscode() (string, error)
	GetSecureShellConfigurationByApplicationNameSpaceProcessTypeAndIndex(appName string, spaceGUID string, processType string, processIndex uint) (v7action.SSHAuthentication, v7action.Warnings, error)
	GetSecurityGroup(securityGroupName string) (resources.SecurityGroup, v7action.Warnings, error)
	GetSecurityGroupSummary(securityGroupName string) (v7action.SecurityGroupSummary, v7action.Warnings, error)
	GetSecurityGroups() ([]v7action.SecurityGroupSummary, v7action.Warnings, error)
	GetServiceAccess(offeringName, brokerName, orgName string) ([]v7action.ServicePlanAccess, v7action.Warnings, error)
	GetServiceBrokerByName(serviceBrokerName string) (v7action.ServiceBroker, v7action.Warnings, error)
	GetServiceBrokerLabels(serviceBrokerName string) (map[string]types.NullString, v7action.Warnings, error)
	GetServiceBrokers() ([]v7action.ServiceBroker, v7action.Warnings, error)
	GetServiceOfferingLabels(serviceOfferingName, serviceBrokerName string) (map[string]types.NullString, v7action.Warnings, error)
	GetServicePlanLabels(servicePlanName, serviceOfferingName, serviceBrokerName string) (map[string]types.NullString, v7action.Warnings, error)
	GetSpaceByNameAndOrganization(spaceName string, orgGUID string) (v7action.Space, v7action.Warnings, error)
	GetSpaceFeature(spaceName string, orgGUID string, feature string) (bool, v7action.Warnings, error)
	GetSpaceLabels(spaceName string, orgGUID string) (map[string]types.NullString, v7action.Warnings, error)
	GetSpaceQuotaByName(spaceQuotaName string, orgGUID string) (resources.SpaceQuota, v7action.Warnings, error)
	GetSpaceQuotasByOrgGUID(orgGUID string) ([]resources.SpaceQuota, v7action.Warnings, error)
	GetSpaceSummaryByNameAndOrganization(spaceName string, orgGUID string) (v7action.SpaceSummary, v7action.Warnings, error)
	GetSpaceUsersByRoleType(spaceGuid string) (map[constant.RoleType][]resources.User, v7action.Warnings, error)
	GetStackByName(stackName string) (v7action.Stack, v7action.Warnings, error)
	GetStackLabels(stackName string) (map[string]types.NullString, v7action.Warnings, error)
	GetStacks(string) ([]v7action.Stack, v7action.Warnings, error)
	GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client sharedaction.LogCacheClient) (<-chan sharedaction.LogMessage, <-chan error, context.CancelFunc, v7action.Warnings, error)
	GetTaskBySequenceIDAndApplication(sequenceID int, appGUID string) (v7action.Task, v7action.Warnings, error)
	GetUnstagedNewestPackageGUID(appGuid string) (string, v7action.Warnings, error)
	GetUser(username, origin string) (resources.User, error)
	MapRoute(routeGUID string, appGUID string) (v7action.Warnings, error)
	Marketplace(filter v7action.MarketplaceFilter) ([]v7action.ServiceOfferingWithPlans, v7action.Warnings, error)
	ParseAccessToken(accessToken string) (jwt.JWT, error)
	PollBuild(buildGUID string, appName string) (resources.Droplet, v7action.Warnings, error)
	PollPackage(pkg v7action.Package) (v7action.Package, v7action.Warnings, error)
	PollStart(app resources.Application, noWait bool, handleProcessStats func(string)) (v7action.Warnings, error)
	PollStartForRolling(app resources.Application, deploymentGUID string, noWait bool, handleProcessStats func(string)) (v7action.Warnings, error)
	PollUploadBuildpackJob(jobURL ccv3.JobURL) (v7action.Warnings, error)
	PrepareBuildpackBits(inputPath string, tmpDirPath string, downloader v7action.Downloader) (string, error)
	PurgeServiceOfferingByNameAndBroker(serviceOfferingName, serviceBrokerName string) (v7action.Warnings, error)
	RefreshAccessToken() (string, error)
	RenameApplicationByNameAndSpaceGUID(oldAppName, newAppName, spaceGUID string) (resources.Application, v7action.Warnings, error)
	RenameOrganization(oldOrgName, newOrgName string) (resources.Organization, v7action.Warnings, error)
	RenameSpaceByNameAndOrganizationGUID(oldSpaceName, newSpaceName, orgGUID string) (v7action.Space, v7action.Warnings, error)
	ResetOrganizationDefaultIsolationSegment(orgGUID string) (v7action.Warnings, error)
	ResetSpaceIsolationSegment(orgGUID string, spaceGUID string) (string, v7action.Warnings, error)
	ResourceMatch(resources []sharedaction.V3Resource) ([]sharedaction.V3Resource, v7action.Warnings, error)
	RestartApplication(appGUID string, noWait bool) (v7action.Warnings, error)
	RunTask(appGUID string, task v7action.Task) (v7action.Task, v7action.Warnings, error)
	ScaleProcessByApplication(appGUID string, process v7action.Process) (v7action.Warnings, error)
	ScheduleTokenRefresh(func(time.Duration) <-chan time.Time, chan struct{}, chan struct{}) (<-chan error, error)
	SetApplicationDroplet(appGUID string, dropletGUID string) (v7action.Warnings, error)
	SetApplicationDropletByApplicationNameAndSpace(appName string, spaceGUID string, dropletGUID string) (v7action.Warnings, error)
	SetApplicationManifest(appGUID string, rawManifest []byte) (v7action.Warnings, error)
	SetApplicationProcessHealthCheckTypeByNameAndSpace(appName string, spaceGUID string, healthCheckType constant.HealthCheckType, httpEndpoint string, processType string, invocationTimeout int64) (resources.Application, v7action.Warnings, error)
	SetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, envPair v7action.EnvironmentVariablePair) (v7action.Warnings, error)
	SetEnvironmentVariableGroup(group constant.EnvironmentVariableGroupName, envVars ccv3.EnvironmentVariables) (v7action.Warnings, error)
	SetOrganizationDefaultIsolationSegment(orgGUID string, isoSegGUID string) (v7action.Warnings, error)
	SetSpaceManifest(spaceGUID string, rawManifest []byte) (v7action.Warnings, error)
	SetTarget(settings v7action.TargetSettings) (v7action.Warnings, error)
	SharePrivateDomain(domainName string, orgName string) (v7action.Warnings, error)
	StageApplicationPackage(pkgGUID string) (v7action.Build, v7action.Warnings, error)
	StagePackage(packageGUID, appName, spaceGUID string) (<-chan resources.Droplet, <-chan v7action.Warnings, <-chan error)
	StartApplication(appGUID string) (v7action.Warnings, error)
	StopApplication(appGUID string) (v7action.Warnings, error)
	TerminateTask(taskGUID string) (v7action.Task, v7action.Warnings, error)
	UAAAPIVersion() string
	UnbindSecurityGroup(securityGroupName string, orgGUID string, spaceGUID string, lifecycle constant.SecurityGroupLifecycle) (v7action.Warnings, error)
	UnmapRoute(routeGUID string, destinationGUID string) (v7action.Warnings, error)
	UnsetEnvironmentVariableByApplicationNameAndSpace(appName string, spaceGUID string, EnvironmentVariableName string) (v7action.Warnings, error)
	UnsetSpaceQuota(spaceQuotaName, spaceName, orgGUID string) (v7action.Warnings, error)
	UnsharePrivateDomain(domainName string, orgName string) (v7action.Warnings, error)
	UpdateAppFeature(app resources.Application, enabled bool, featureName string) (v7action.Warnings, error)
	UpdateApplication(app resources.Application) (resources.Application, v7action.Warnings, error)
	UpdateApplicationLabelsByApplicationName(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateBuildpackByNameAndStack(buildpackName string, buildpackStack string, buildpack v7action.Buildpack) (v7action.Buildpack, v7action.Warnings, error)
	UpdateBuildpackLabelsByBuildpackNameAndStack(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateDomainLabelsByDomainName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateOrganizationLabelsByOrganizationName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateOrganizationQuota(quotaName string, newName string, limits v7action.QuotaLimits) (v7action.Warnings, error)
	UpdateProcessByTypeAndApplication(processType string, appGUID string, updatedProcess v7action.Process) (v7action.Warnings, error)
	UpdateRouteLabels(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateSecurityGroup(name, filePath string) (v7action.Warnings, error)
	UpdateSecurityGroupGloballyEnabled(securityGroupName string, lifecycle constant.SecurityGroupLifecycle, enabled bool) (v7action.Warnings, error)
	UpdateServiceBroker(serviceBrokerGUID string, model v7action.ServiceBrokerModel) (v7action.Warnings, error)
	UpdateServiceBrokerLabelsByServiceBrokerName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateServiceOfferingLabels(serviceOfferingName string, serviceBrokerName string, labels map[string]types.NullString) (v7action.Warnings, error)
	UpdateServicePlanLabels(servicePlanName string, serviceOfferingName string, serviceBrokerName string, labels map[string]types.NullString) (v7action.Warnings, error)
	UpdateSpaceFeature(spaceName string, orgGUID string, enableds bool, feature string) (v7action.Warnings, error)
	UpdateSpaceLabelsBySpaceName(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateSpaceQuota(quotaName, orgGUID, newName string, limits v7action.QuotaLimits) (v7action.Warnings, error)
	UpdateStackLabelsByStackName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateUserPassword(userGUID string, oldPassword string, newPassword string) error
	UploadBitsPackage(pkg v7action.Package, matchedResources []sharedaction.V3Resource, newResources io.Reader, newResourcesLength int64) (v7action.Package, v7action.Warnings, error)
	UploadBuildpack(guid string, pathToBuildpackBits string, progressBar v7action.SimpleProgressBar) (ccv3.JobURL, v7action.Warnings, error)
	UploadDroplet(dropletGUID string, dropletPath string, progressReader io.Reader, fileSize int64) (v7action.Warnings, error)
}

type ActorReloader

type ActorReloader interface {
	Reload(command.Config, command.UI) (Actor, error)
}

type ActualActorReloader

type ActualActorReloader struct{}

func (ActualActorReloader) Reload

func (a ActualActorReloader) Reload(config command.Config, ui command.UI) (Actor, error)

type AddNetworkPolicyCommand

type AddNetworkPolicyCommand struct {
	BaseCommand

	RequiredArgs flag.AddNetworkPolicyArgsV7 `positional-args:"yes"`
	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)"`

	DestinationOrg   string `short:"o" description:"The org of the destination app (Default: targeted org)"`
	DestinationSpace string `short:"s" description:"The space of the destination app (Default: targeted space)"`

	NetworkingActor NetworkingActor
	// contains filtered or unexported fields
}

func (AddNetworkPolicyCommand) Execute

func (cmd AddNetworkPolicyCommand) Execute(args []string) error

func (*AddNetworkPolicyCommand) Setup

func (cmd *AddNetworkPolicyCommand) Setup(config command.Config, ui command.UI) error

type AllowSpaceSSHCommand

type AllowSpaceSSHCommand struct {
	BaseCommand

	RequiredArgs flag.Space `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*AllowSpaceSSHCommand) Execute

func (cmd *AllowSpaceSSHCommand) Execute(args []string) error

type AppCommand

type AppCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	GUID         bool         `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (AppCommand) Execute

func (cmd AppCommand) Execute(args []string) error

type ApplyManifestCommand

type ApplyManifestCommand struct {
	BaseCommand

	PathToManifest   flag.ManifestPathWithExistenceCheck `short:"f" description:"Path to app manifest"`
	Vars             []template.VarKV                    `long:"var" description:"Variable key value pair for variable substitution, (e.g., name=app1); can specify multiple times"`
	PathsToVarsFiles []flag.PathWithExistenceCheck       `long:"vars-file" description:"Path to a variable substitution file for manifest; can specify multiple times"`

	ManifestLocator ManifestLocator
	ManifestParser  ManifestParser
	CWD             string
	// contains filtered or unexported fields
}

func (ApplyManifestCommand) Execute

func (cmd ApplyManifestCommand) Execute(args []string) error

func (*ApplyManifestCommand) Setup

func (cmd *ApplyManifestCommand) Setup(config command.Config, ui command.UI) error

type AppsCommand

type AppsCommand struct {
	BaseCommand

	Labels string `long:"labels" description:"Selector to filter apps by labels"`
	// contains filtered or unexported fields
}

func (AppsCommand) Execute

func (cmd AppsCommand) Execute(args []string) error

type AuthCommand

type AuthCommand struct {
	BaseCommand

	RequiredArgs      flag.Authentication `positional-args:"yes"`
	ClientCredentials bool                `long:"client-credentials" description:"Use (non-user) service account (also called client credentials)"`
	Origin            string              `long:"origin" description:"Indicates the identity provider to be used for authentication"`
	// contains filtered or unexported fields
}

func (AuthCommand) Execute

func (cmd AuthCommand) Execute(args []string) error

type BaseCommand

type BaseCommand struct {
	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       Actor
	// contains filtered or unexported fields
}

func (*BaseCommand) GetClients

func (cmd *BaseCommand) GetClients() (*ccv3.Client, *uaa.Client)

func (*BaseCommand) Setup

func (cmd *BaseCommand) Setup(config command.Config, ui command.UI) error

type BindRunningSecurityGroupCommand

type BindRunningSecurityGroupCommand struct {
	BaseCommand

	SecurityGroup flag.SecurityGroup `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (BindRunningSecurityGroupCommand) Execute

func (cmd BindRunningSecurityGroupCommand) Execute(args []string) error

type BindSecurityGroupCommand

type BindSecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.BindSecurityGroupV7Args `positional-args:"yes"`
	Lifecycle    flag.SecurityGroupLifecycle  `long:"lifecycle" choice:"running" choice:"staging" default:"running" description:"Lifecycle phase the group applies to."`
	Space        string                       `long:"space" description:"Space to bind the security group to. (Default: all existing spaces in org)"`
	// contains filtered or unexported fields
}

func (BindSecurityGroupCommand) Execute

func (cmd BindSecurityGroupCommand) Execute(args []string) error

type BindStagingSecurityGroupCommand

type BindStagingSecurityGroupCommand struct {
	BaseCommand

	SecurityGroup flag.SecurityGroup `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (BindStagingSecurityGroupCommand) Execute

func (cmd BindStagingSecurityGroupCommand) Execute(args []string) error

type BuildpacksCommand

type BuildpacksCommand struct {
	BaseCommand

	Labels string `long:"labels" description:"Selector to filter buildpacks by labels"`
	// contains filtered or unexported fields
}

func (BuildpacksCommand) Execute

func (cmd BuildpacksCommand) Execute(args []string) error

type CancelDeploymentCommand

type CancelDeploymentCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*CancelDeploymentCommand) Execute

func (cmd *CancelDeploymentCommand) Execute(args []string) error

type CheckRouteCommand

type CheckRouteCommand struct {
	BaseCommand

	RequiredArgs flag.Domain      `positional-args:"yes"`
	Hostname     string           `long:"hostname" short:"n" description:"Hostname used to identify the HTTP route"`
	Path         flag.V7RoutePath `long:"path" description:"Path for the route"`
	// contains filtered or unexported fields
}

func (CheckRouteCommand) Execute

func (cmd CheckRouteCommand) Execute(args []string) error

type ConfigCommand

type ConfigCommand struct {
	UI           command.UI
	Config       command.Config
	AsyncTimeout flag.Timeout      `long:"async-timeout" description:"Timeout in minutes for async HTTP requests"`
	Color        flag.Color        `long:"color" description:"Enable or disable color in CLI output"`
	Locale       flag.Locale       `long:"locale" description:"Set default locale. If LOCALE is 'CLEAR', previous locale is deleted."`
	Trace        flag.PathWithBool `` /* 177-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (ConfigCommand) Execute

func (cmd ConfigCommand) Execute(args []string) error

func (*ConfigCommand) Setup

func (cmd *ConfigCommand) Setup(config command.Config, ui command.UI) error

type CopySourceCommand

type CopySourceCommand struct {
	BaseCommand

	RequiredArgs flag.CopySourceArgs `positional-args:"yes"`

	Strategy     flag.DeploymentStrategy `long:"strategy" description:"Deployment strategy, either rolling or null"`
	NoWait       bool                    `long:"no-wait" description:"Exit when the first instance of the web process is healthy"`
	NoRestart    bool                    `long:"no-restart" description:"Do not restage the destination application"`
	Organization string                  `short:"o" long:"organization" description:"Org that contains the destination application"`
	Space        string                  `short:"s" long:"space" description:"Space that contains the destination application"`

	Stager shared.AppStager
	// contains filtered or unexported fields
}

func (CopySourceCommand) Execute

func (cmd CopySourceCommand) Execute(args []string) error

func (*CopySourceCommand) Setup

func (cmd *CopySourceCommand) Setup(config command.Config, ui command.UI) error

func (*CopySourceCommand) ValidateFlags

func (cmd *CopySourceCommand) ValidateFlags() error

type CreateAppCommand

type CreateAppCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	AppType      flag.AppType `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (CreateAppCommand) Execute

func (cmd CreateAppCommand) Execute(args []string) error

type CreateAppManifestCommand

type CreateAppManifestCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	FilePath     flag.Path    `` /* 135-byte string literal not displayed */

	PWD string
	// contains filtered or unexported fields
}

func (CreateAppManifestCommand) Execute

func (cmd CreateAppManifestCommand) Execute(args []string) error

func (*CreateAppManifestCommand) Setup

func (cmd *CreateAppManifestCommand) Setup(config command.Config, ui command.UI) error

type CreateBuildpackCommand

type CreateBuildpackCommand struct {
	BaseCommand

	RequiredArgs flag.CreateBuildpackArgs `positional-args:"Yes"`

	Disable bool `long:"disable" description:"Disable the buildpack from being used for staging"`

	ProgressBar v7action.SimpleProgressBar
	// contains filtered or unexported fields
}

func (CreateBuildpackCommand) Execute

func (cmd CreateBuildpackCommand) Execute(args []string) error

func (*CreateBuildpackCommand) Setup

func (cmd *CreateBuildpackCommand) Setup(config command.Config, ui command.UI) error

type CreateIsolationSegmentCommand

type CreateIsolationSegmentCommand struct {
	BaseCommand
	RequiredArgs flag.IsolationSegmentName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (CreateIsolationSegmentCommand) Execute

func (cmd CreateIsolationSegmentCommand) Execute(args []string) error

type CreateOrgCommand

type CreateOrgCommand struct {
	BaseCommand

	RequiredArgs flag.Organization `positional-args:"yes"`
	Quota        string            `short:"q" long:"quota" description:"Quota to assign to the newly created org"`
	// contains filtered or unexported fields
}

func (CreateOrgCommand) Execute

func (cmd CreateOrgCommand) Execute(args []string) error

type CreateOrgQuotaCommand

type CreateOrgQuotaCommand struct {
	BaseCommand

	RequiredArgs          flag.OrganizationQuota   `positional-args:"yes"`
	NumAppInstances       flag.IntegerLimit        `short:"a" description:"Total number of application instances. (Default: unlimited)."`
	PaidServicePlans      bool                     `long:"allow-paid-service-plans" description:"Allow provisioning instances of paid service plans. (Default: disallowed)."`
	PerProcessMemory      flag.MemoryWithUnlimited `short:"i" description:"Maximum amount of memory a process can have (e.g. 1024M, 1G, 10G). (Default: unlimited)."`
	TotalMemory           flag.MemoryWithUnlimited `` /* 142-byte string literal not displayed */
	TotalRoutes           flag.IntegerLimit        `short:"r" description:"Total number of routes. -1 represents an unlimited amount. (Default: 0)."`
	TotalReservedPorts    flag.IntegerLimit        `` /* 147-byte string literal not displayed */
	TotalServiceInstances flag.IntegerLimit        `short:"s" description:"Total number of service instances. -1 represents an unlimited amount. (Default: 0)."`
	// contains filtered or unexported fields
}

func (CreateOrgQuotaCommand) Execute

func (cmd CreateOrgQuotaCommand) Execute(args []string) error

type CreatePackageCommand

type CreatePackageCommand struct {
	BaseCommand

	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"`

	PackageDisplayer shared.PackageDisplayer
	// contains filtered or unexported fields
}

func (CreatePackageCommand) Execute

func (cmd CreatePackageCommand) Execute(args []string) error

func (*CreatePackageCommand) Setup

func (cmd *CreatePackageCommand) Setup(config command.Config, ui command.UI) error

type CreatePrivateDomainCommand

type CreatePrivateDomainCommand struct {
	BaseCommand

	RequiredArgs flag.OrgDomain `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (CreatePrivateDomainCommand) Execute

func (cmd CreatePrivateDomainCommand) Execute(args []string) error

type CreateRouteCommand

type CreateRouteCommand struct {
	BaseCommand

	RequiredArgs flag.Domain `positional-args:"yes"`

	Hostname string           `long:"hostname" short:"n" description:"Hostname for the HTTP route (required for shared domains)"`
	Path     flag.V7RoutePath `long:"path" description:"Path for the HTTP route"`
	Port     int              `long:"port" description:"Port for the TCP route (default: random port)"`
	// contains filtered or unexported fields
}

func (CreateRouteCommand) Execute

func (cmd CreateRouteCommand) Execute(args []string) error

type CreateSecurityGroupCommand

type CreateSecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SecurityGroupArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (CreateSecurityGroupCommand) Execute

func (cmd CreateSecurityGroupCommand) Execute(args []string) error

type CreateServiceBrokerCommand

type CreateServiceBrokerCommand struct {
	BaseCommand

	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
}

func (*CreateServiceBrokerCommand) Execute

func (cmd *CreateServiceBrokerCommand) Execute(args []string) error

type CreateSharedDomainCommand

type CreateSharedDomainCommand struct {
	BaseCommand

	RequiredArgs flag.Domain `positional-args:"yes"`
	RouterGroup  string      `long:"router-group" description:"Routes for this domain will use routers in the specified router group"`
	Internal     bool        `long:"internal" description:"Applications that use internal routes communicate directly on the container network"`
	// contains filtered or unexported fields
}

func (CreateSharedDomainCommand) Execute

func (cmd CreateSharedDomainCommand) Execute(args []string) error

type CreateSpaceActor

type CreateSpaceActor interface {
	CreateSpace(spaceName, orgGUID string) (v7action.Space, v7action.Warnings, error)
	CreateSpaceRole(roleType constant.RoleType, orgGUID string, spaceGUID string, userNameOrGUID string, userOrigin string, isClient bool) (v7action.Warnings, error)
	GetOrganizationByName(orgName string) (resources.Organization, v7action.Warnings, error)
	ApplySpaceQuotaByName(quotaName string, spaceGUID string, orgGUID string) (v7action.Warnings, error)
}

type CreateSpaceCommand

type CreateSpaceCommand struct {
	BaseCommand

	RequiredArgs flag.Space `positional-args:"yes"`
	Organization string     `short:"o" description:"Organization"`
	Quota        string     `long:"quota" short:"q" description:"Quota to assign to the newly created space"`
	// contains filtered or unexported fields
}

func (CreateSpaceCommand) Execute

func (cmd CreateSpaceCommand) Execute(args []string) error

type CreateSpaceQuotaCommand

type CreateSpaceQuotaCommand struct {
	BaseCommand

	RequiredArgs          flag.SpaceQuota          `positional-args:"yes"`
	NumAppInstances       flag.IntegerLimit        `short:"a" description:"Total number of application instances. (Default: unlimited)."`
	PaidServicePlans      bool                     `long:"allow-paid-service-plans" description:"Allow provisioning instances of paid service plans. (Default: disallowed)."`
	PerProcessMemory      flag.MemoryWithUnlimited `short:"i" description:"Maximum amount of memory a process can have (e.g. 1024M, 1G, 10G). (Default: unlimited)."`
	TotalMemory           flag.MemoryWithUnlimited `` /* 141-byte string literal not displayed */
	TotalRoutes           flag.IntegerLimit        `short:"r" description:"Total number of routes. -1 represents an unlimited amount. (Default: 0)."`
	TotalReservedPorts    flag.IntegerLimit        `` /* 147-byte string literal not displayed */
	TotalServiceInstances flag.IntegerLimit        `short:"s" description:"Total number of service instances. -1 represents an unlimited amount. (Default: 0)."`
	// contains filtered or unexported fields
}

func (CreateSpaceQuotaCommand) Execute

func (cmd CreateSpaceQuotaCommand) Execute([]string) error

type CreateUserCommand

type CreateUserCommand struct {
	BaseCommand

	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"`
	PasswordPrompt bool            `long:"password-prompt" description:"Prompt interactively for password"`
	// contains filtered or unexported fields
}

func (*CreateUserCommand) Execute

func (cmd *CreateUserCommand) Execute(args []string) error

type DeleteBuildpackCommand

type DeleteBuildpackCommand struct {
	BaseCommand

	RequiredArgs flag.BuildpackName `positional-args:"yes"`

	Force bool   `long:"force" short:"f" description:"Force deletion without confirmation"`
	Stack string `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (DeleteBuildpackCommand) Execute

func (cmd DeleteBuildpackCommand) Execute(args []string) error

type DeleteCommand

type DeleteCommand struct {
	BaseCommand

	RequiredArgs       flag.AppName `positional-args:"yes"`
	Force              bool         `short:"f" description:"Force deletion without confirmation"`
	DeleteMappedRoutes bool         `short:"r" description:"Also delete any mapped routes"`
	// contains filtered or unexported fields
}

func (DeleteCommand) Execute

func (cmd DeleteCommand) Execute(args []string) error

type DeleteIsolationSegmentCommand

type DeleteIsolationSegmentCommand struct {
	BaseCommand

	RequiredArgs flag.IsolationSegmentName `positional-args:"yes"`
	Force        bool                      `short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (DeleteIsolationSegmentCommand) Execute

func (cmd DeleteIsolationSegmentCommand) Execute(args []string) error

type DeleteOrgCommand

type DeleteOrgCommand struct {
	BaseCommand

	RequiredArgs flag.Organization `positional-args:"yes"`
	Force        bool              `short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (*DeleteOrgCommand) Execute

func (cmd *DeleteOrgCommand) Execute(args []string) error

type DeleteOrgQuotaCommand

type DeleteOrgQuotaCommand struct {
	BaseCommand

	RequiredArgs flag.Quota `positional-args:"yes"`
	Force        bool       `long:"force" short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (DeleteOrgQuotaCommand) Execute

func (cmd DeleteOrgQuotaCommand) Execute(args []string) error

type DeleteOrphanedRoutesCommand

type DeleteOrphanedRoutesCommand struct {
	BaseCommand

	Force bool `short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (DeleteOrphanedRoutesCommand) Execute

func (cmd DeleteOrphanedRoutesCommand) Execute(args []string) error

type DeletePrivateDomainCommand

type DeletePrivateDomainCommand struct {
	BaseCommand

	RequiredArgs flag.Domain `positional-args:"yes"`
	Force        bool        `short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (DeletePrivateDomainCommand) Execute

func (cmd DeletePrivateDomainCommand) Execute(args []string) error

type DeleteRouteCommand

type DeleteRouteCommand struct {
	BaseCommand

	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 (required for shared domains)"`
	Path     flag.V7RoutePath `long:"path" description:"Path used to identify the HTTP route"`
	// contains filtered or unexported fields
}

func (DeleteRouteCommand) Execute

func (cmd DeleteRouteCommand) Execute(args []string) error

type DeleteSecurityGroupCommand

type DeleteSecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SecurityGroup `positional-args:"yes"`
	Force        bool               `long:"force" short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (*DeleteSecurityGroupCommand) Execute

func (cmd *DeleteSecurityGroupCommand) Execute(args []string) error

type DeleteServiceBrokerCommand

type DeleteServiceBrokerCommand struct {
	BaseCommand

	RequiredArgs flag.ServiceBroker `positional-args:"yes"`

	Force bool `short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (DeleteServiceBrokerCommand) Execute

func (cmd DeleteServiceBrokerCommand) Execute(args []string) error

type DeleteSharedDomainCommand

type DeleteSharedDomainCommand struct {
	BaseCommand

	RequiredArgs flag.Domain `positional-args:"yes"`
	Force        bool        `short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (DeleteSharedDomainCommand) Execute

func (cmd DeleteSharedDomainCommand) Execute(args []string) error

type DeleteSpaceCommand

type DeleteSpaceCommand struct {
	BaseCommand

	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"`
	// contains filtered or unexported fields
}

func (DeleteSpaceCommand) Execute

func (cmd DeleteSpaceCommand) Execute(args []string) error

type DeleteSpaceQuotaCommand

type DeleteSpaceQuotaCommand struct {
	BaseCommand

	RequiredArgs flag.Quota `positional-args:"yes"`
	Force        bool       `long:"force" short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (DeleteSpaceQuotaCommand) Execute

func (cmd DeleteSpaceQuotaCommand) Execute(args []string) error

type DeleteUserCommand

type DeleteUserCommand struct {
	BaseCommand

	RequiredArgs flag.Username `positional-args:"yes"`
	Force        bool          `short:"f" description:"Prompt interactively for password"`
	Origin       string        `long:"origin" description:"Origin for mapping a user account to a user in an external identity provider"`
	// contains filtered or unexported fields
}

func (*DeleteUserCommand) Execute

func (cmd *DeleteUserCommand) Execute(args []string) error

type DisableFeatureFlagCommand

type DisableFeatureFlagCommand struct {
	BaseCommand

	RequiredArgs flag.Feature `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (DisableFeatureFlagCommand) Execute

func (cmd DisableFeatureFlagCommand) Execute(args []string) error

type DisableOrgIsolationCommand

type DisableOrgIsolationCommand struct {
	BaseCommand

	RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (DisableOrgIsolationCommand) Execute

func (cmd DisableOrgIsolationCommand) Execute(args []string) error

type DisableSSHCommand

type DisableSSHCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*DisableSSHCommand) Execute

func (cmd *DisableSSHCommand) Execute(args []string) error

type DisableServiceAccessCommand

type DisableServiceAccessCommand struct {
	BaseCommand

	RequiredArgs  flag.Service `positional-args:"yes"`
	ServiceBroker string       `` /* 143-byte string literal not displayed */
	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
}

func (DisableServiceAccessCommand) Execute

func (cmd DisableServiceAccessCommand) Execute(args []string) error

type DisallowSpaceSSHCommand

type DisallowSpaceSSHCommand struct {
	BaseCommand

	RequiredArgs flag.Space `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*DisallowSpaceSSHCommand) Execute

func (cmd *DisallowSpaceSSHCommand) Execute(args []string) error

type DomainsCommand

type DomainsCommand struct {
	BaseCommand

	Labels string `long:"labels" description:"Selector to filter domains by labels"`
	// contains filtered or unexported fields
}

func (DomainsCommand) Execute

func (cmd DomainsCommand) Execute(args []string) error

type DropletsCommand

type DropletsCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (DropletsCommand) Execute

func (cmd DropletsCommand) Execute(args []string) error

type EnableFeatureFlagCommand

type EnableFeatureFlagCommand struct {
	BaseCommand

	RequiredArgs flag.Feature `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (EnableFeatureFlagCommand) Execute

func (cmd EnableFeatureFlagCommand) Execute(args []string) error

type EnableOrgIsolationCommand

type EnableOrgIsolationCommand struct {
	BaseCommand
	RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (EnableOrgIsolationCommand) Execute

func (cmd EnableOrgIsolationCommand) Execute(args []string) error

type EnableSSHCommand

type EnableSSHCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*EnableSSHCommand) Execute

func (cmd *EnableSSHCommand) Execute(args []string) error

type EnableServiceAccessCommand

type EnableServiceAccessCommand struct {
	BaseCommand

	RequiredArgs  flag.Service `positional-args:"yes"`
	ServiceBroker string       `` /* 142-byte string literal not displayed */
	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
}

func (EnableServiceAccessCommand) Execute

func (cmd EnableServiceAccessCommand) Execute(args []string) error

type EnvCommand

type EnvCommand struct {
	BaseCommand

	RequiredArgs flag.EnvironmentArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (EnvCommand) Execute

func (cmd EnvCommand) Execute(_ []string) error

type EventsCommand

type EventsCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (EventsCommand) Execute

func (cmd EventsCommand) Execute(_ []string) error

type FeatureFlagCommand

type FeatureFlagCommand struct {
	BaseCommand

	RequiredArgs flag.Feature `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (FeatureFlagCommand) Execute

func (cmd FeatureFlagCommand) Execute(args []string) error

type FeatureFlagsCommand

type FeatureFlagsCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (FeatureFlagsCommand) Execute

func (cmd FeatureFlagsCommand) Execute(args []string) error

type GetHealthCheckCommand

type GetHealthCheckCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (GetHealthCheckCommand) DisplayProcessTable

func (cmd GetHealthCheckCommand) DisplayProcessTable(processHealthChecks []v7action.ProcessHealthCheck) error

func (GetHealthCheckCommand) Execute

func (cmd GetHealthCheckCommand) Execute(args []string) error

type IsolationSegmentsCommand

type IsolationSegmentsCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (IsolationSegmentsCommand) Execute

func (cmd IsolationSegmentsCommand) Execute(args []string) error

type LabelSetter

type LabelSetter interface {
	Execute(resource TargetResource, labels map[string]types.NullString) error
}

type LabelUnsetter

type LabelUnsetter interface {
	Execute(resource TargetResource, labels map[string]types.NullString) error
}

type LabelUpdater

type LabelUpdater struct {
	UI          command.UI
	Config      command.Config
	SharedActor command.SharedActor
	Actor       SetLabelActor

	Username string
	Action   ActionType
	// contains filtered or unexported fields
}

func (*LabelUpdater) Execute

func (cmd *LabelUpdater) Execute(targetResource TargetResource, labels map[string]types.NullString) error

type LabelsCommand

type LabelsCommand struct {
	BaseCommand

	RequiredArgs   flag.LabelsArgs `positional-args:"yes"`
	BuildpackStack string          `long:"stack" short:"s" description:"Specify stack to disambiguate buildpacks with the same name"`

	ServiceBroker   string `` /* 133-byte string literal not displayed */
	ServiceOffering string `long:"offering" short:"e" description:"Specify a service offering to disambiguate service plans with the same name."`
	// contains filtered or unexported fields
}

func (LabelsCommand) Execute

func (cmd LabelsCommand) Execute(args []string) error

type LoginCommand

type LoginCommand struct {
	UI            command.UI
	Actor         Actor
	Config        command.Config
	ActorReloader ActorReloader

	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"`
	Origin            string `long:"origin" description:"Indicates the identity provider to be used for login"`
	// contains filtered or unexported fields
}

func (*LoginCommand) Execute

func (cmd *LoginCommand) Execute(args []string) error

func (*LoginCommand) Setup

func (cmd *LoginCommand) Setup(config command.Config, ui command.UI) error

type LogoutCommand

type LogoutCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (LogoutCommand) Execute

func (cmd LogoutCommand) Execute(args []string) error

type LogsCommand

type LogsCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	Recent       bool         `long:"recent" description:"Dump recent logs instead of tailing"`

	CC_Client      *ccv3.Client
	LogCacheClient sharedaction.LogCacheClient
	// contains filtered or unexported fields
}

func (LogsCommand) Execute

func (cmd LogsCommand) Execute(args []string) error

func (*LogsCommand) Setup

func (cmd *LogsCommand) Setup(config command.Config, ui command.UI) error

type ManifestLocator

type ManifestLocator interface {
	Path(filepathOrDirectory string) (string, bool, error)
}

type ManifestParser

type ManifestParser interface {
	InterpolateAndParse(pathToManifest string, pathsToVarsFiles []string, vars []template.VarKV) (manifestparser.Manifest, error)
	MarshalManifest(manifest manifestparser.Manifest) ([]byte, error)
}

type MapRouteCommand

type MapRouteCommand struct {
	BaseCommand

	RequiredArgs flag.AppDomain `positional-args:"yes"`

	Hostname string           `long:"hostname" short:"n" description:"Hostname for the HTTP route (required for shared domains)"`
	Path     flag.V7RoutePath `long:"path" description:"Path for the HTTP route"`
	Port     int              `long:"port" description:"Port for the TCP route (default: random port)"`
	// contains filtered or unexported fields
}

func (MapRouteCommand) Execute

func (cmd MapRouteCommand) Execute(args []string) error

type MarketplaceCommand

type MarketplaceCommand struct {
	BaseCommand

	ServiceOfferingName string `short:"e" description:"Show plan details for a particular service offering"`
	ServiceBrokerName   string `short:"b" description:"Only show details for a particular service broker"`
	NoPlans             bool   `long:"no-plans" description:"Hide plan information for service offerings"`
	// contains filtered or unexported fields
}

func (MarketplaceCommand) Execute

func (cmd MarketplaceCommand) Execute(args []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 {
	BaseCommand

	SourceApp string `long:"source" required:"false" description:"Source app to filter results by"`

	NetworkingActor NetworkPoliciesActor
	// contains filtered or unexported fields
}

func (NetworkPoliciesCommand) Execute

func (cmd NetworkPoliciesCommand) Execute(args []string) error

func (*NetworkPoliciesCommand) Setup

func (cmd *NetworkPoliciesCommand) Setup(config command.Config, ui command.UI) error

type NetworkingActor

type NetworkingActor interface {
	AddNetworkPolicy(srcSpaceGUID string, srcAppName string, destSpaceGUID string, destAppName string, protocol string, startPort int, endPort int) (cfnetworkingaction.Warnings, error)
}

type OauthTokenCommand

type OauthTokenCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (OauthTokenCommand) Execute

func (cmd OauthTokenCommand) Execute(_ []string) error

type OrgCommand

type OrgCommand struct {
	BaseCommand

	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."`
	// contains filtered or unexported fields
}

func (OrgCommand) Execute

func (cmd OrgCommand) Execute(args []string) error

type OrgQuotaCommand

type OrgQuotaCommand struct {
	BaseCommand

	RequiredArgs flag.OrganizationQuota `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (OrgQuotaCommand) Execute

func (cmd OrgQuotaCommand) Execute(args []string) error

type OrgQuotasCommand

type OrgQuotasCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (OrgQuotasCommand) Execute

func (cmd OrgQuotasCommand) Execute(args []string) error

type OrgUsersCommand

type OrgUsersCommand struct {
	BaseCommand

	RequiredArgs flag.Organization `positional-args:"yes"`
	AllUsers     bool              `long:"all-users" short:"a" description:"List all users with roles in the org or in spaces within the org"`
	// contains filtered or unexported fields
}

func (*OrgUsersCommand) Execute

func (cmd *OrgUsersCommand) Execute(args []string) error

type OrgsCommand

type OrgsCommand struct {
	BaseCommand

	Labels string `long:"labels" description:"Selector to filter orgs by labels"`
	// contains filtered or unexported fields
}

func (OrgsCommand) Execute

func (cmd OrgsCommand) Execute(args []string) error

type PackagesCommand

type PackagesCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (PackagesCommand) Execute

func (cmd PackagesCommand) Execute(args []string) error

type PasswdCommand

type PasswdCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (PasswdCommand) Execute

func (cmd PasswdCommand) Execute(args []string) error

type ProgressBar

type ProgressBar interface {
	v7pushaction.ProgressBar
	Complete()
	Ready()
}

type PurgeServiceOfferingCommand

type PurgeServiceOfferingCommand struct {
	BaseCommand

	RequiredArgs  flag.Service `positional-args:"yes"`
	ServiceBroker string       `` /* 131-byte string literal not displayed */
	Force         bool         `short:"f" description:"Force deletion without confirmation"`
	// contains filtered or unexported fields
}

func (PurgeServiceOfferingCommand) Execute

func (cmd PurgeServiceOfferingCommand) Execute(args []string) error

type PushActor

type PushActor interface {
	HandleFlagOverrides(baseManifest manifestparser.Manifest, flagOverrides v7pushaction.FlagOverrides) (manifestparser.Manifest, error)
	CreatePushPlans(spaceGUID string, orgGUID string, manifest manifestparser.Manifest, overrides v7pushaction.FlagOverrides) ([]v7pushaction.PushPlan, v7action.Warnings, error)
	// Actualize applies any necessary changes.
	Actualize(plan v7pushaction.PushPlan, progressBar v7pushaction.ProgressBar) <-chan *v7pushaction.PushEvent
}

type PushCommand

type PushCommand struct {
	BaseCommand

	OptionalArgs            flag.OptionalAppName                `positional-args:"yes"`
	HealthCheckTimeout      flag.PositiveInteger                `` /* 155-byte string literal not displayed */
	Buildpacks              []string                            `` /* 334-byte string literal not displayed */
	Disk                    string                              `long:"disk" short:"k" description:"Disk limit (e.g. 256M, 1024M, 1G)"`
	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"`
	DropletPath             flag.PathWithExistenceCheck         `long:"droplet" description:"Path to a tgz file with a pre-staged app"`
	HealthCheckHTTPEndpoint string                              `` /* 129-byte string literal not displayed */
	HealthCheckType         flag.HealthCheckType                `` /* 157-byte string literal not displayed */
	Instances               flag.Instances                      `long:"instances" short:"i" description:"Number of instances"`
	PathToManifest          flag.ManifestPathWithExistenceCheck `long:"manifest" short:"f" description:"Path to manifest"`
	Memory                  string                              `long:"memory" short:"m" description:"Memory limit (e.g. 256M, 1024M, 1G)"`
	NoManifest              bool                                `long:"no-manifest" description:"Ignore manifest file"`
	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"`
	NoWait                  bool                                `long:"no-wait" description:"Exit when the first instance of the web process is healthy"`
	AppPath                 flag.PathWithExistenceCheck         `long:"path" 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 (except when no-route is specified in the manifest)"`
	Stack                   string                              `` /* 136-byte string literal not displayed */
	StartCommand            flag.Command                        `long:"start-command" short:"c" description:"Startup command, set to null to reset to default start command"`
	Strategy                flag.DeploymentStrategy             `long:"strategy" description:"Deployment strategy, either rolling or null."`
	Task                    bool                                `` /* 146-byte string literal not displayed */
	Vars                    []template.VarKV                    `long:"var" description:"Variable key value pair for variable substitution, (e.g., name=app1); can specify multiple times"`
	PathsToVarsFiles        []flag.PathWithExistenceCheck       `long:"vars-file" description:"Path to a variable substitution file for manifest; can specify multiple times"`

	LogCacheClient  sharedaction.LogCacheClient
	PushActor       PushActor
	VersionActor    V7ActorForPush
	ProgressBar     ProgressBar
	CWD             string
	ManifestLocator ManifestLocator
	ManifestParser  ManifestParser
	// contains filtered or unexported fields
}

func (PushCommand) Execute

func (cmd PushCommand) Execute(args []string) error

func (PushCommand) GetBaseManifest

func (cmd PushCommand) GetBaseManifest(flagOverrides v7pushaction.FlagOverrides) (manifestparser.Manifest, error)

func (PushCommand) GetDockerPassword

func (cmd PushCommand) GetDockerPassword(dockerUsername string, containsPrivateDockerImages bool) (string, error)

func (PushCommand) GetFlagOverrides

func (cmd PushCommand) GetFlagOverrides() (v7pushaction.FlagOverrides, error)

func (*PushCommand) Setup

func (cmd *PushCommand) Setup(config command.Config, ui command.UI) error

func (PushCommand) ValidateFlags

func (cmd PushCommand) ValidateFlags() error

type RemoveNetworkPolicyActor

type RemoveNetworkPolicyActor interface {
	RemoveNetworkPolicy(srcSpaceGUID string, srcAppName string, destSpaceGUID string, destAppName string, protocol string, startPort int, endPort int) (cfnetworkingaction.Warnings, error)
}

type RemoveNetworkPolicyCommand

type RemoveNetworkPolicyCommand struct {
	BaseCommand

	RequiredArgs     flag.RemoveNetworkPolicyArgsV7 `positional-args:"yes"`
	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"`
	DestinationOrg   string                         `short:"o" description:"The org of the destination app (Default: targeted org)"`
	DestinationSpace string                         `short:"s" description:"The space of the destination app (Default: targeted space)"`

	NetworkingActor RemoveNetworkPolicyActor
	// contains filtered or unexported fields
}

func (RemoveNetworkPolicyCommand) Execute

func (cmd RemoveNetworkPolicyCommand) Execute(args []string) error

func (*RemoveNetworkPolicyCommand) Setup

func (cmd *RemoveNetworkPolicyCommand) Setup(config command.Config, ui command.UI) error

type RenameCommand

type RenameCommand struct {
	BaseCommand

	RequiredArgs flag.Rename `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (RenameCommand) Execute

func (cmd RenameCommand) Execute(args []string) error

type RenameOrgCommand

type RenameOrgCommand struct {
	BaseCommand

	RequiredArgs flag.RenameOrgArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (RenameOrgCommand) Execute

func (cmd RenameOrgCommand) Execute(args []string) error

type RenameServiceBrokerCommand

type RenameServiceBrokerCommand struct {
	BaseCommand

	RequiredArgs flag.RenameServiceBrokerArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*RenameServiceBrokerCommand) Execute

func (cmd *RenameServiceBrokerCommand) Execute(args []string) error

type RenameSpaceCommand

type RenameSpaceCommand struct {
	BaseCommand

	RequiredArgs flag.RenameSpace `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (RenameSpaceCommand) Execute

func (cmd RenameSpaceCommand) Execute(args []string) error

type ResetOrgDefaultIsolationSegmentCommand

type ResetOrgDefaultIsolationSegmentCommand struct {
	BaseCommand

	RequiredArgs flag.ResetOrgDefaultIsolationArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (ResetOrgDefaultIsolationSegmentCommand) Execute

type ResetSpaceIsolationSegmentCommand

type ResetSpaceIsolationSegmentCommand struct {
	BaseCommand

	RequiredArgs flag.ResetSpaceIsolationArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (ResetSpaceIsolationSegmentCommand) Execute

func (cmd ResetSpaceIsolationSegmentCommand) Execute(args []string) error

type ResourceType

type ResourceType string
const (
	App             ResourceType = "app"
	Buildpack       ResourceType = "buildpack"
	Domain          ResourceType = "domain"
	Org             ResourceType = "org"
	Route           ResourceType = "route"
	Space           ResourceType = "space"
	Stack           ResourceType = "stack"
	ServiceBroker   ResourceType = "service-broker"
	ServiceOffering ResourceType = "service-offering"
	ServicePlan     ResourceType = "service-plan"
)

type RestageCommand

type RestageCommand struct {
	BaseCommand

	RequiredArgs flag.AppName            `positional-args:"yes"`
	Strategy     flag.DeploymentStrategy `long:"strategy" description:"Deployment strategy, either rolling or null."`
	NoWait       bool                    `long:"no-wait" description:"Exit when the first instance of the web process is healthy"`

	Stager shared.AppStager
	// contains filtered or unexported fields
}

func (RestageCommand) Execute

func (cmd RestageCommand) Execute(args []string) error

func (*RestageCommand) Setup

func (cmd *RestageCommand) Setup(config command.Config, ui command.UI) error

type RestartAppInstanceCommand

type RestartAppInstanceCommand struct {
	BaseCommand

	RequiredArgs flag.AppInstance `positional-args:"yes"`
	ProcessType  string           `long:"process" default:"web" description:"Process to restart"`
	// contains filtered or unexported fields
}

func (RestartAppInstanceCommand) Execute

func (cmd RestartAppInstanceCommand) Execute(args []string) error

type RestartCommand

type RestartCommand struct {
	BaseCommand

	RequiredArgs flag.AppName            `positional-args:"yes"`
	Strategy     flag.DeploymentStrategy `long:"strategy" description:"Deployment strategy, either rolling or null."`
	NoWait       bool                    `long:"no-wait" description:"Exit when the first instance of the web process is healthy"`

	Stager shared.AppStager
	// contains filtered or unexported fields
}

func (RestartCommand) Execute

func (cmd RestartCommand) Execute(args []string) error

func (*RestartCommand) Setup

func (cmd *RestartCommand) Setup(config command.Config, ui command.UI) error

type RouterGroupsCommand

type RouterGroupsCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (RouterGroupsCommand) Execute

func (cmd RouterGroupsCommand) Execute(args []string) error

type RoutesCommand

type RoutesCommand struct {
	BaseCommand

	Orglevel bool   `long:"org-level" description:"List all the routes for all spaces of current organization"`
	Labels   string `long:"labels" description:"Selector to filter routes by labels"`
	// contains filtered or unexported fields
}

func (RoutesCommand) Execute

func (cmd RoutesCommand) Execute(args []string) error

type RunTaskCommand

type RunTaskCommand struct {
	BaseCommand

	RequiredArgs flag.RunTaskArgsV7 `positional-args:"yes"`
	Command      string             `long:"command" short:"c" description:"The command to execute"`
	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)"`
	Process      string             `long:"process" description:"Process type to use as a template for command, memory, and disk for the created task."`
	// contains filtered or unexported fields
}

func (RunTaskCommand) Execute

func (cmd RunTaskCommand) Execute(args []string) error

type RunningEnvironmentVariableGroupCommand

type RunningEnvironmentVariableGroupCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (RunningEnvironmentVariableGroupCommand) Execute

type RunningSecurityGroupsCommand

type RunningSecurityGroupsCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (RunningSecurityGroupsCommand) Execute

func (cmd RunningSecurityGroupsCommand) Execute(args []string) error

type SSHCodeCommand

type SSHCodeCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (SSHCodeCommand) Execute

func (cmd SSHCodeCommand) Execute(args []string) error

type SSHCommand

type SSHCommand struct {
	BaseCommand

	RequiredArgs          flag.AppName             `positional-args:"yes"`
	ProcessIndex          uint                     `long:"app-instance-index" short:"i" default:"0" description:"App process instance index"`
	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" default:"web" description:"App process name"`
	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"`

	SSHActor  SharedSSHActor
	SSHClient *clissh.SecureShell
	// contains filtered or unexported fields
}

func (SSHCommand) EvaluateTTYOption

func (cmd SSHCommand) EvaluateTTYOption() (sharedaction.TTYOption, error)

EvaluateTTYOption determines which TTY options are mutually exclusive and returns an error accordingly.

func (SSHCommand) Execute

func (cmd SSHCommand) Execute(args []string) error

func (*SSHCommand) Setup

func (cmd *SSHCommand) Setup(config command.Config, ui command.UI) error

type SSHEnabledCommand

type SSHEnabledCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*SSHEnabledCommand) Execute

func (cmd *SSHEnabledCommand) Execute(args []string) error

type ScaleCommand

type ScaleCommand struct {
	BaseCommand

	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"`
	// contains filtered or unexported fields
}

func (ScaleCommand) Execute

func (cmd ScaleCommand) Execute(args []string) error

type SecurityGroupCommand

type SecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SecurityGroup `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SecurityGroupCommand) Execute

func (cmd SecurityGroupCommand) Execute(args []string) error

type SecurityGroupsCommand

type SecurityGroupsCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (SecurityGroupsCommand) Execute

func (cmd SecurityGroupsCommand) Execute(args []string) error

type ServiceAccessCommand

type ServiceAccessCommand struct {
	BaseCommand

	Broker          string `short:"b" description:"Access for plans of a particular broker"`
	ServiceOffering string `short:"e" description:"Access for plans of a particular service offering"`
	Organization    string `short:"o" description:"Plans accessible by a particular organization"`
	// contains filtered or unexported fields
}

func (ServiceAccessCommand) Execute

func (cmd ServiceAccessCommand) Execute(args []string) error

type ServiceBrokersCommand

type ServiceBrokersCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (*ServiceBrokersCommand) Execute

func (cmd *ServiceBrokersCommand) Execute(args []string) error

type SetDropletCommand

type SetDropletCommand struct {
	BaseCommand
	RequiredArgs flag.AppDroplet `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SetDropletCommand) Execute

func (cmd SetDropletCommand) Execute(args []string) error

type SetEnvCommand

type SetEnvCommand struct {
	BaseCommand

	RequiredArgs flag.SetEnvironmentArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SetEnvCommand) Execute

func (cmd SetEnvCommand) Execute(args []string) error

type SetHealthCheckCommand

type SetHealthCheckCommand struct {
	BaseCommand

	RequiredArgs      flag.SetHealthCheckArgs `positional-args:"yes"`
	HTTPEndpoint      string                  `long:"endpoint" default:"/" description:"Path on the app"`
	InvocationTimeout flag.PositiveInteger    `long:"invocation-timeout" description:"Time (in seconds) that controls individual health check invocations"`
	ProcessType       string                  `long:"process" default:"web" description:"App process to update"`
	// contains filtered or unexported fields
}

func (SetHealthCheckCommand) Execute

func (cmd SetHealthCheckCommand) Execute(args []string) error

type SetLabelActor

type SetLabelActor interface {
	UpdateApplicationLabelsByApplicationName(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateBuildpackLabelsByBuildpackNameAndStack(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateDomainLabelsByDomainName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateOrganizationLabelsByOrganizationName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateRouteLabels(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateSpaceLabelsBySpaceName(string, string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateStackLabelsByStackName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateServiceBrokerLabelsByServiceBrokerName(string, map[string]types.NullString) (v7action.Warnings, error)
	UpdateServiceOfferingLabels(serviceOfferingName string, serviceBrokerName string, labels map[string]types.NullString) (v7action.Warnings, error)
	UpdateServicePlanLabels(servicePlanName string, serviceOfferingName string, serviceBrokerName string, labels map[string]types.NullString) (v7action.Warnings, error)
}

type SetLabelCommand

type SetLabelCommand struct {
	BaseCommand

	RequiredArgs flag.SetLabelArgs `positional-args:"yes"`

	BuildpackStack  string `long:"stack" short:"s" description:"Specify stack to disambiguate buildpacks with the same name"`
	ServiceBroker   string `` /* 133-byte string literal not displayed */
	ServiceOffering string `long:"offering" short:"e" description:"Specify a service offering to disambiguate service plans with the same name."`

	LabelSetter LabelSetter
	// contains filtered or unexported fields
}

func (SetLabelCommand) Execute

func (cmd SetLabelCommand) Execute(args []string) error

func (*SetLabelCommand) Setup

func (cmd *SetLabelCommand) Setup(config command.Config, ui command.UI) error

type SetOrgDefaultIsolationSegmentCommand

type SetOrgDefaultIsolationSegmentCommand struct {
	BaseCommand

	RequiredArgs flag.OrgIsolationArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SetOrgDefaultIsolationSegmentCommand) Execute

type SetOrgQuotaCommand

type SetOrgQuotaCommand struct {
	BaseCommand

	RequiredArgs flag.SetOrgQuotaArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*SetOrgQuotaCommand) Execute

func (cmd *SetOrgQuotaCommand) Execute(args []string) error

type SetOrgRoleCommand

type SetOrgRoleCommand struct {
	BaseCommand

	Args     flag.OrgRoleArgs `positional-args:"yes"`
	IsClient bool             `long:"client" description:"Assign an org role to a client-id of a (non-user) service account"`
	Origin   string           `long:"origin" description:"Indicates the identity provider to be used for authentication"`
	// contains filtered or unexported fields
}

func (*SetOrgRoleCommand) Execute

func (cmd *SetOrgRoleCommand) Execute(args []string) error

type SetRunningEnvironmentVariableGroupCommand

type SetRunningEnvironmentVariableGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SetEnvVarGroup `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SetRunningEnvironmentVariableGroupCommand) Execute

type SetSpaceIsolationSegmentCommand

type SetSpaceIsolationSegmentCommand struct {
	BaseCommand

	RequiredArgs flag.SpaceIsolationArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SetSpaceIsolationSegmentCommand) Execute

func (cmd SetSpaceIsolationSegmentCommand) Execute(args []string) error

type SetSpaceQuotaCommand

type SetSpaceQuotaCommand struct {
	BaseCommand

	RequiredArgs flag.SetSpaceQuotaArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*SetSpaceQuotaCommand) Execute

func (cmd *SetSpaceQuotaCommand) Execute(args []string) error

type SetSpaceRoleCommand

type SetSpaceRoleCommand struct {
	BaseCommand

	Args     flag.SpaceRoleArgs `positional-args:"yes"`
	IsClient bool               `long:"client" description:"Assign a space role to a client-id of a (non-user) service account"`
	Origin   string             `long:"origin" description:"Indicates the identity provider to be used for authentication"`
	// contains filtered or unexported fields
}

func (*SetSpaceRoleCommand) Execute

func (cmd *SetSpaceRoleCommand) Execute(args []string) error

type SetStagingEnvironmentVariableGroupCommand

type SetStagingEnvironmentVariableGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SetEnvVarGroup `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SetStagingEnvironmentVariableGroupCommand) Execute

type SharePrivateDomainCommand

type SharePrivateDomainCommand struct {
	BaseCommand

	RequiredArgs flag.OrgDomain `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SharePrivateDomainCommand) Execute

func (cmd SharePrivateDomainCommand) Execute(args []string) error

type SharedSSHActor

type SharedSSHActor interface {
	ExecuteSecureShell(sshClient sharedaction.SecureShellClient, sshOptions sharedaction.SSHOptions) error
}

type SpaceCommand

type SpaceCommand struct {
	BaseCommand

	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."`
	// contains filtered or unexported fields
}

func (SpaceCommand) Execute

func (cmd SpaceCommand) Execute(args []string) error

type SpaceQuotaCommand

type SpaceQuotaCommand struct {
	BaseCommand

	RequiredArgs flag.SpaceQuota `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SpaceQuotaCommand) Execute

func (cmd SpaceQuotaCommand) Execute(args []string) error

type SpaceQuotasCommand

type SpaceQuotasCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (SpaceQuotasCommand) Execute

func (cmd SpaceQuotasCommand) Execute(args []string) error

type SpaceSSHAllowedCommand

type SpaceSSHAllowedCommand struct {
	BaseCommand

	RequiredArgs flag.Space `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (SpaceSSHAllowedCommand) Execute

func (cmd SpaceSSHAllowedCommand) Execute(args []string) error

type SpaceUsersCommand

type SpaceUsersCommand struct {
	BaseCommand

	RequiredArgs flag.SpaceUsersArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*SpaceUsersCommand) Execute

func (cmd *SpaceUsersCommand) Execute(args []string) error

type SpacesCommand

type SpacesCommand struct {
	BaseCommand

	Labels string `long:"labels" description:"Selector to filter spaces by labels"`
	// contains filtered or unexported fields
}

func (SpacesCommand) Execute

func (cmd SpacesCommand) Execute([]string) error

type StackCommand

type StackCommand struct {
	BaseCommand

	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
}

func (*StackCommand) Execute

func (cmd *StackCommand) Execute(args []string) error

type StacksCommand

type StacksCommand struct {
	BaseCommand

	Labels string `long:"labels" description:"Selector to filter stacks by labels"`
	// contains filtered or unexported fields
}

func (StacksCommand) Execute

func (cmd StacksCommand) Execute(args []string) error

type StagePackageCommand

type StagePackageCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	PackageGUID  string       `long:"package-guid" description:"The guid of the package to stage (default: latest ready package)"`

	LogCacheClient sharedaction.LogCacheClient
	// contains filtered or unexported fields
}

func (StagePackageCommand) Execute

func (cmd StagePackageCommand) Execute(args []string) error

func (*StagePackageCommand) Setup

func (cmd *StagePackageCommand) Setup(config command.Config, ui command.UI) error

type StagingEnvironmentVariableGroupCommand

type StagingEnvironmentVariableGroupCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (StagingEnvironmentVariableGroupCommand) Execute

type StagingSecurityGroupsCommand

type StagingSecurityGroupsCommand struct {
	BaseCommand
	// contains filtered or unexported fields
}

func (StagingSecurityGroupsCommand) Execute

func (cmd StagingSecurityGroupsCommand) Execute(args []string) error

type StartCommand

type StartCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`

	LogCacheClient sharedaction.LogCacheClient
	Stager         shared.AppStager
	// contains filtered or unexported fields
}

func (StartCommand) Execute

func (cmd StartCommand) Execute(args []string) error

func (*StartCommand) Setup

func (cmd *StartCommand) Setup(config command.Config, ui command.UI) error

type StopCommand

type StopCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (StopCommand) Execute

func (cmd StopCommand) Execute(args []string) error

type TargetCommand

type TargetCommand struct {
	BaseCommand

	Organization string `short:"o" description:"Organization"`
	Space        string `short:"s" description:"Space"`
	// contains filtered or unexported fields
}

func (*TargetCommand) Execute

func (cmd *TargetCommand) Execute(args []string) error

type TargetResource

type TargetResource struct {
	ResourceType    string
	ResourceName    string
	BuildpackStack  string
	ServiceBroker   string
	ServiceOffering string
}

type TasksCommand

type TasksCommand struct {
	BaseCommand

	RequiredArgs flag.AppName `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (TasksCommand) Execute

func (cmd TasksCommand) Execute(args []string) error

type TerminateTaskCommand

type TerminateTaskCommand struct {
	BaseCommand

	RequiredArgs flag.TerminateTaskArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (TerminateTaskCommand) Execute

func (cmd TerminateTaskCommand) Execute(args []string) error

type UnbindRunningSecurityGroupCommand

type UnbindRunningSecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SecurityGroup `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (UnbindRunningSecurityGroupCommand) Execute

func (cmd UnbindRunningSecurityGroupCommand) Execute(args []string) error

type UnbindSecurityGroupCommand

type UnbindSecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.UnbindSecurityGroupV7Args `positional-args:"yes"`
	Lifecycle    flag.SecurityGroupLifecycle    `long:"lifecycle" choice:"running" choice:"staging" default:"running" description:"Lifecycle phase the group applies to"`
	// contains filtered or unexported fields
}

func (UnbindSecurityGroupCommand) Execute

func (cmd UnbindSecurityGroupCommand) Execute(args []string) error

type UnbindStagingSecurityGroupCommand

type UnbindStagingSecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SecurityGroup `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (UnbindStagingSecurityGroupCommand) Execute

func (cmd UnbindStagingSecurityGroupCommand) Execute(args []string) error

type UnmapRouteCommand

type UnmapRouteCommand struct {
	BaseCommand

	RequiredArgs flag.AppDomain   `positional-args:"yes"`
	Hostname     string           `long:"hostname" short:"n" description:"Hostname used to identify the HTTP route"`
	Path         flag.V7RoutePath `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
}

func (UnmapRouteCommand) Execute

func (cmd UnmapRouteCommand) Execute(args []string) error

type UnsetEnvCommand

type UnsetEnvCommand struct {
	BaseCommand

	RequiredArgs flag.UnsetEnvironmentArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (UnsetEnvCommand) Execute

func (cmd UnsetEnvCommand) Execute(args []string) error

type UnsetLabelCommand

type UnsetLabelCommand struct {
	BaseCommand

	RequiredArgs flag.UnsetLabelArgs `positional-args:"yes"`

	BuildpackStack  string `long:"stack" short:"s" description:"Specify stack to disambiguate buildpacks with the same name"`
	ServiceBroker   string `` /* 133-byte string literal not displayed */
	ServiceOffering string `long:"offering" short:"e" description:"Specify a service offering to disambiguate service plans with the same name."`

	LabelUnsetter LabelUnsetter
	// contains filtered or unexported fields
}

func (UnsetLabelCommand) Execute

func (cmd UnsetLabelCommand) Execute(args []string) error

func (*UnsetLabelCommand) Setup

func (cmd *UnsetLabelCommand) Setup(config command.Config, ui command.UI) error

type UnsetOrgRoleCommand

type UnsetOrgRoleCommand struct {
	BaseCommand

	Args     flag.OrgRoleArgs `positional-args:"yes"`
	IsClient bool             `long:"client" description:"Unassign an org role for a client-id of a (non-user) service account"`
	Origin   string           `long:"origin" description:"Indicates the identity provider to be used for authentication"`
	// contains filtered or unexported fields
}

func (*UnsetOrgRoleCommand) Execute

func (cmd *UnsetOrgRoleCommand) Execute(args []string) error

type UnsetSpaceQuotaCommand

type UnsetSpaceQuotaCommand struct {
	BaseCommand

	RequiredArgs flag.UnsetSpaceQuotaArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (*UnsetSpaceQuotaCommand) Execute

func (cmd *UnsetSpaceQuotaCommand) Execute(args []string) error

type UnsetSpaceRoleCommand

type UnsetSpaceRoleCommand struct {
	BaseCommand

	Args     flag.SpaceRoleArgs `positional-args:"yes"`
	IsClient bool               `long:"client" description:"Remove space role from a client-id of a (non-user) service account"`
	Origin   string             `long:"origin" description:"Indicates the identity provider to be used for authentication"`
	// contains filtered or unexported fields
}

func (*UnsetSpaceRoleCommand) Execute

func (cmd *UnsetSpaceRoleCommand) Execute(args []string) error

type UnsharePrivateDomainCommand

type UnsharePrivateDomainCommand struct {
	BaseCommand

	RequiredArgs flag.OrgDomain `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (UnsharePrivateDomainCommand) Execute

func (cmd UnsharePrivateDomainCommand) Execute(args []string) error

type UpdateBuildpackActor

type UpdateBuildpackActor interface {
	UpdateBuildpackByNameAndStack(buildpackName string, buildpackStack string, buildpack v7action.Buildpack) (v7action.Buildpack, v7action.Warnings, error)
	UploadBuildpack(guid string, pathToBuildpackBits string, progressBar v7action.SimpleProgressBar) (ccv3.JobURL, v7action.Warnings, error)
	PrepareBuildpackBits(inputPath string, tmpDirPath string, downloader v7action.Downloader) (string, error)
	PollUploadBuildpackJob(jobURL ccv3.JobURL) (v7action.Warnings, error)
}

type UpdateBuildpackCommand

type UpdateBuildpackCommand struct {
	BaseCommand

	RequiredArgs flag.BuildpackName `positional-args:"Yes"`

	NewStack     string                           `long:"assign-stack" description:"Assign a stack to a buildpack that does not have a stack association"`
	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"`
	Lock         bool                             `long:"lock" description:"Lock the buildpack to prevent updates"`
	Path         flag.PathWithExistenceCheckOrURL `long:"path" short:"p" description:"Path to directory or zip file"`
	Position     types.NullInt                    `long:"position" short:"i" description:"The order in which the buildpacks are checked during buildpack auto-detection"`
	NewName      string                           `long:"rename" description:"Rename an existing buildpack"`
	CurrentStack string                           `long:"stack" short:"s" description:"Specify stack to disambiguate buildpacks with the same name"`
	Unlock       bool                             `long:"unlock" description:"Unlock the buildpack to enable updates"`

	ProgressBar v7action.SimpleProgressBar
	// contains filtered or unexported fields
}

func (UpdateBuildpackCommand) Execute

func (cmd UpdateBuildpackCommand) Execute(args []string) error

func (*UpdateBuildpackCommand) Setup

func (cmd *UpdateBuildpackCommand) Setup(config command.Config, ui command.UI) error

type UpdateOrgQuotaCommand

type UpdateOrgQuotaCommand struct {
	BaseCommand

	RequiredArgs          flag.OrganizationQuota   `positional-args:"Yes"`
	NumAppInstances       flag.IntegerLimit        `short:"a" description:"Total number of application instances. -1 represents an unlimited amount."`
	PaidServicePlans      bool                     `long:"allow-paid-service-plans" description:"Allow provisioning instances of paid service plans."`
	NoPaidServicePlans    bool                     `long:"disallow-paid-service-plans" description:"Disallow provisioning instances of paid service plans."`
	PerProcessMemory      flag.MemoryWithUnlimited `short:"i" description:"Maximum amount of memory a process can have (e.g. 1024M, 1G, 10G). -1 represents an unlimited amount."`
	TotalMemory           flag.MemoryWithUnlimited `` /* 128-byte string literal not displayed */
	NewName               string                   `short:"n" description:"New name"`
	TotalRoutes           flag.IntegerLimit        `short:"r" description:"Total number of routes. -1 represents an unlimited amount."`
	TotalReservedPorts    flag.IntegerLimit        `` /* 133-byte string literal not displayed */
	TotalServiceInstances flag.IntegerLimit        `short:"s" description:"Total number of service instances. -1 represents an unlimited amount."`
	// contains filtered or unexported fields
}

func (UpdateOrgQuotaCommand) Execute

func (cmd UpdateOrgQuotaCommand) Execute(args []string) error

type UpdateSecurityGroupCommand

type UpdateSecurityGroupCommand struct {
	BaseCommand

	RequiredArgs flag.SecurityGroupArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (UpdateSecurityGroupCommand) Execute

func (cmd UpdateSecurityGroupCommand) Execute(args []string) error

type UpdateServiceBrokerCommand

type UpdateServiceBrokerCommand struct {
	BaseCommand

	RequiredArgs flag.ServiceBrokerArgs `positional-args:"yes"`
	// contains filtered or unexported fields
}

func (UpdateServiceBrokerCommand) Execute

func (cmd UpdateServiceBrokerCommand) Execute(args []string) error

type UpdateSpaceQuotaCommand

type UpdateSpaceQuotaCommand struct {
	BaseCommand

	RequiredArgs          flag.SpaceQuota          `positional-args:"Yes"`
	NumAppInstances       flag.IntegerLimit        `short:"a" description:"Total number of application instances. -1 represents an unlimited amount."`
	PaidServicePlans      bool                     `long:"allow-paid-service-plans" description:"Allow provisioning instances of paid service plans."`
	NoPaidServicePlans    bool                     `long:"disallow-paid-service-plans" description:"Disallow provisioning instances of paid service plans."`
	PerProcessMemory      flag.MemoryWithUnlimited `short:"i" description:"Maximum amount of memory a process can have (e.g. 1024M, 1G, 10G). -1 represents an unlimited amount."`
	TotalMemory           flag.MemoryWithUnlimited `` /* 128-byte string literal not displayed */
	NewName               string                   `short:"n" description:"New name"`
	TotalRoutes           flag.IntegerLimit        `short:"r" description:"Total number of routes. -1 represents an unlimited amount."`
	TotalReservedPorts    flag.IntegerLimit        `` /* 133-byte string literal not displayed */
	TotalServiceInstances flag.IntegerLimit        `short:"s" description:"Total number of service instances. -1 represents an unlimited amount."`
	// contains filtered or unexported fields
}

func (UpdateSpaceQuotaCommand) Execute

func (cmd UpdateSpaceQuotaCommand) Execute(args []string) error

type V7ActorForPush

type V7ActorForPush interface {
	GetApplicationByNameAndSpace(name string, spaceGUID string) (resources.Application, v7action.Warnings, error)
	GetDetailedAppSummary(appName string, spaceGUID string, withObfuscatedValues bool) (v7action.DetailedApplicationSummary, v7action.Warnings, error)
	SetSpaceManifest(spaceGUID string, rawManifest []byte) (v7action.Warnings, error)
	GetStreamingLogsForApplicationByNameAndSpace(appName string, spaceGUID string, client sharedaction.LogCacheClient) (<-chan sharedaction.LogMessage, <-chan error, context.CancelFunc, v7action.Warnings, error)
	RestartApplication(appGUID string, noWait bool) (v7action.Warnings, error)
}

Source Files

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL