resources

package

Go to main page

Versions in this module

v8

v8.18.4

Jun 29, 2026

v8.18.3

Apr 15, 2026

v8.18.2

Apr 13, 2026

v8.18.1

Apr 9, 2026

Changes in this version

+ type EmbeddedProcessInstance struct

+ Index int64

+ Since int64

+ State string

type Process

+ EmbeddedProcessInstances []EmbeddedProcessInstance

v8.18.0

Mar 4, 2026

Changes in this version

+ const StackStateActive

+ const StackStateDeprecated

+ const StackStateDisabled

+ const StackStateRestricted

+ var ValidStackStates = []string

+ func ValidStackStatesLowercase() []string

+ type BindingStrategyType string

+ const MultipleBindingStrategy

+ const SingleBindingStrategy

type ServiceCredentialBinding

+ CreatedAt string

+ Strategy BindingStrategyType

type Stack

+ State string

+ StateReason string

v8.17.1

Feb 12, 2026

Changes in this version

type Droplet

+ Lifecycle DropletLifecycle

+ type DropletLifecycle struct

+ Type string

v8.17.0

Nov 18, 2025

Changes in this version

+ func CreateRouteOptions(options []string) (map[string]*string, *string)

+ func RemoveRouteOptions(options []string) map[string]*string

+ type APILink struct

+ HREF string

+ Meta APILinkMeta

+ Method string

+ type APILinkMeta struct

+ HostKeyFingerprint string

+ OAuthClient string

+ Version string

+ type APILinks map[string]APILink

+ type AppLimit struct

+ InstanceMemory *types.NullInt

+ TotalAppInstances *types.NullInt

+ TotalLogVolume *types.NullInt

+ TotalMemory *types.NullInt

+ func (al *AppLimit) UnmarshalJSON(rawJSON []byte) error

+ type Application struct

+ Credentials map[string]interface{}

+ CurrentDropletGUID string

+ GUID string

+ LifecycleBuildpacks []string

+ LifecycleType constant.AppLifecycleType

+ Metadata *Metadata

+ Name string

+ SpaceGUID string

+ StackName string

+ State constant.ApplicationState

+ func (a *Application) UnmarshalJSON(data []byte) error

+ func (a Application) MarshalJSON() ([]byte, error)

+ func (a Application) Started() bool

+ func (a Application) Stopped() bool

+ type ApplicationFeature struct

+ Enabled bool

+ Name string

+ type ApplicationNameOnly struct

+ Name string

+ type Build struct

+ CreatedAt string

+ DropletGUID string

+ Error string

+ GUID string

+ PackageGUID string

+ State constant.BuildState

+ func (b *Build) UnmarshalJSON(data []byte) error

+ func (b Build) MarshalJSON() ([]byte, error)

+ type Buildpack struct

+ Enabled types.NullBool

+ Filename string

+ GUID string

+ Lifecycle string

+ Links APILinks

+ Locked types.NullBool

+ Metadata *Metadata

+ Name string

+ Position types.NullInt

+ Stack string

+ State string

+ func (buildpack *Buildpack) UnmarshalJSON(data []byte) error

+ func (buildpack Buildpack) MarshalJSON() ([]byte, error)

+ type CanaryDeploymentOptions struct

+ Steps []CanaryStep

+ type CanaryStatus struct

+ Steps CanaryStepStatus

+ type CanaryStep struct

+ InstanceWeight int64

+ type CanaryStepStatus struct

+ CurrentStep int

+ TotalSteps int

+ type Deployment struct

+ CanaryStatus CanaryStatus

+ CreatedAt string

+ DropletGUID string

+ GUID string

+ LastStatusChange string

+ NewProcesses []Process

+ Options DeploymentOpts

+ Relationships Relationships

+ RevisionGUID string

+ State constant.DeploymentState

+ StatusReason constant.DeploymentStatusReason

+ StatusValue constant.DeploymentStatusValue

+ Strategy constant.DeploymentStrategy

+ UpdatedAt string

+ func (d *Deployment) UnmarshalJSON(data []byte) error

+ func (d Deployment) MarshalJSON() ([]byte, error)

+ type DeploymentOpts struct

+ CanaryDeploymentOptions *CanaryDeploymentOptions

+ DiskInMB types.NullUint64

+ Instances types.NullInt

+ LogRateLimitInBPS types.NullInt

+ MaxInFlight int

+ MemoryInMB types.NullUint64

+ func (d DeploymentOpts) IsEmpty() bool

+ type Diff struct

+ Op DiffOperation

+ Path string

+ Value interface{}

+ Was interface{}

+ type DiffOperation string

+ const AddOperation

+ const RemoveOperation

+ const ReplaceOperation

+ type Domain struct

+ GUID string

+ Internal types.NullBool

+ Metadata *Metadata

+ Name string

+ OrganizationGUID string

+ Protocols []string

+ RouterGroup string

+ func (d *Domain) IsTCP() bool

+ func (d *Domain) UnmarshalJSON(data []byte) error

+ func (d Domain) MarshalJSON() ([]byte, error)

+ func (d Domain) Shared() bool

+ type Droplet struct

+ AppGUID string

+ Buildpacks []DropletBuildpack

+ CreatedAt string

+ GUID string

+ Image string

+ IsCurrent bool

+ Stack string

+ State constant.DropletState

+ func (d *Droplet) UnmarshalJSON(data []byte) error

+ func (d Droplet) MarshallJSON() ([]byte, error)

+ type DropletBuildpack struct

+ BuildpackName string

+ DetectOutput string

+ Name string

+ Version string

+ type EnvironmentVariables map[string]types.FilteredString

+ func (variables *EnvironmentVariables) UnmarshalJSON(data []byte) error

+ func (variables EnvironmentVariables) MarshalJSON() ([]byte, error)

+ type FeatureFlag struct

+ Enabled bool

+ Name string

+ func (f FeatureFlag) MarshalJSON() ([]byte, error)

+ type IncludedUsers map[constant.IncludedType]User

+ type IsolationSegment struct

+ GUID string

+ Name string

+ type K8sUser struct

+ Kind string

+ Name string

+ type LastOperation struct

+ CreatedAt string

+ Description string

+ State LastOperationState

+ Type LastOperationType

+ UpdatedAt string

+ func (l LastOperation) OmitJSONry() bool

+ type LastOperationState string

+ const OperationFailed

+ const OperationInProgress

+ const OperationSucceeded

+ type LastOperationType string

+ const CreateOperation

+ const DeleteOperation

+ const UpdateOperation

+ type ManifestDiff struct

+ Diffs []Diff

+ type Metadata struct

+ Annotations map[string]types.NullString

+ Labels map[string]types.NullString

+ type Organization struct

+ GUID string

+ Metadata *Metadata

+ Name string

+ QuotaGUID string

+ Suspended bool

+ func (org *Organization) UnmarshalJSON(data []byte) error

+ type OrganizationQuota struct

+ type Package struct

+ CreatedAt string

+ DockerImage string

+ DockerPassword string

+ DockerUsername string

+ GUID string

+ Links APILinks

+ Relationships Relationships

+ State constant.PackageState

+ Type constant.PackageType

+ func (p *Package) UnmarshalJSON(data []byte) error

+ func (p Package) MarshalJSON() ([]byte, error)

+ type Process struct

+ AppGUID string

+ Command types.FilteredString

+ DiskInMB types.NullUint64

+ GUID string

+ HealthCheckEndpoint string

+ HealthCheckInvocationTimeout int64

+ HealthCheckTimeout int64

+ HealthCheckType constant.HealthCheckType

+ Instances types.NullInt

+ LogRateLimitInBPS types.NullInt

+ MemoryInMB types.NullUint64

+ ReadinessHealthCheckEndpoint string

+ ReadinessHealthCheckInterval int64

+ ReadinessHealthCheckInvocationTimeout int64

+ ReadinessHealthCheckType constant.HealthCheckType

+ Type string

+ func (p *Process) UnmarshalJSON(data []byte) error

+ func (p Process) MarshalJSON() ([]byte, error)

+ type Quota struct

+ Apps AppLimit

+ GUID string

+ Name string

+ Routes RouteLimit

+ Services ServiceLimit

+ type Relationship struct

+ GUID string

+ func (r *Relationship) UnmarshalJSON(data []byte) error

+ func (r Relationship) MarshalJSON() ([]byte, error)

+ type RelationshipList struct

+ GUIDs []string

+ func (r *RelationshipList) UnmarshalJSON(data []byte) error

+ func (r RelationshipList) MarshalJSON() ([]byte, error)

+ type Relationships map[constant.RelationshipType]Relationship

+ type ResourceMetadata struct

+ Metadata *Metadata

+ type Revision struct

+ CreatedAt string

+ Deployable bool

+ Description string

+ Droplet Droplet

+ GUID string

+ Links APILinks

+ Metadata *Metadata

+ UpdatedAt string

+ Version int

+ type Role struct

+ GUID string

+ OrgGUID string

+ Origin string

+ SpaceGUID string

+ Type constant.RoleType

+ UserGUID string

+ Username string

+ func (r *Role) UnmarshalJSON(data []byte) error

+ func (r Role) MarshalJSON() ([]byte, error)

+ type Route struct

+ Destinations []RouteDestination

+ DomainGUID string

+ GUID string

+ Host string

+ Metadata *Metadata

+ Options map[string]*string

+ Path string

+ Port int

+ Protocol string

+ SpaceGUID string

+ URL string

+ func (r *Route) FormattedOptions() string

+ func (r *Route) UnmarshalJSON(data []byte) error

+ func (r Route) MarshalJSON() ([]byte, error)

+ type RouteBinding struct

+ GUID string

+ LastOperation LastOperation

+ Parameters types.OptionalObject

+ RouteGUID string

+ RouteServiceURL string

+ ServiceInstanceGUID string

+ func (s *RouteBinding) UnmarshalJSON(data []byte) error

+ func (s RouteBinding) MarshalJSON() ([]byte, error)

+ type RouteDestination struct

+ App RouteDestinationApp

+ GUID string

+ Port int

+ Protocol string

+ type RouteDestinationApp struct

+ GUID string

+ Process struct{ ... }

+ type RouteLimit struct

+ TotalReservedPorts *types.NullInt

+ TotalRoutes *types.NullInt

+ func (sl *RouteLimit) UnmarshalJSON(rawJSON []byte) error

+ type Rule struct

+ Code *int

+ Description *string

+ Destination string

+ Log *bool

+ Ports *string

+ Protocol string

+ Type *int

+ type SecurityGroup struct

+ GUID string

+ Name string

+ Rules []Rule

+ RunningGloballyEnabled *bool

+ RunningSpaceGUIDs []string

+ StagingGloballyEnabled *bool

+ StagingSpaceGUIDs []string

+ func (sg *SecurityGroup) UnmarshalJSON(data []byte) error

+ func (sg SecurityGroup) MarshalJSON() ([]byte, error)

+ type ServiceBroker struct

+ CredentialsType ServiceBrokerCredentialsType

+ GUID string

+ Metadata *Metadata

+ Name string

+ Password string

+ SpaceGUID string

+ URL string

+ Username string

+ func (s *ServiceBroker) UnmarshalJSON(data []byte) error

+ func (s ServiceBroker) MarshalJSON() ([]byte, error)

+ type ServiceBrokerCredentialsType string

+ const ServiceBrokerBasicCredentials

+ type ServiceCredentialBinding struct

+ AppGUID string

+ AppName string

+ AppSpaceGUID string

+ GUID string

+ LastOperation LastOperation

+ Name string

+ Parameters types.OptionalObject

+ ServiceInstanceGUID string

+ Type ServiceCredentialBindingType

+ func (s *ServiceCredentialBinding) UnmarshalJSON(data []byte) error

+ func (s ServiceCredentialBinding) MarshalJSON() ([]byte, error)

+ type ServiceCredentialBindingDetails struct

+ Credentials map[string]interface{}

+ type ServiceCredentialBindingType string

+ const AppBinding

+ const KeyBinding

+ type ServiceInstance struct

+ Credentials types.OptionalObject

+ DashboardURL types.OptionalString

+ GUID string

+ LastOperation LastOperation

+ MaintenanceInfoVersion string

+ Metadata *Metadata

+ Name string

+ Parameters types.OptionalObject

+ RouteServiceURL types.OptionalString

+ ServicePlanGUID string

+ SpaceGUID string

+ SyslogDrainURL types.OptionalString

+ Tags types.OptionalStringSlice

+ Type ServiceInstanceType

+ UpgradeAvailable types.OptionalBoolean

+ func (s *ServiceInstance) UnmarshalJSON(data []byte) error

+ func (s ServiceInstance) MarshalJSON() ([]byte, error)

+ type ServiceInstanceType string

+ const ManagedServiceInstance

+ const UserProvidedServiceInstance

+ type ServiceInstanceUsageSummary struct

+ BoundAppCount int

+ SpaceGUID string

+ func (s *ServiceInstanceUsageSummary) UnmarshalJSON(data []byte) error

+ type ServiceInstanceUsageSummaryList struct

+ UsageSummary []ServiceInstanceUsageSummary

+ func (s *ServiceInstanceUsageSummaryList) UnmarshalJSON(data []byte) error

+ type ServiceLimit struct

+ PaidServicePlans *bool

+ TotalServiceInstances *types.NullInt

+ func (sl *ServiceLimit) UnmarshalJSON(rawJSON []byte) error

+ type ServiceOffering struct

+ AllowsInstanceSharing bool

+ Description string

+ DocumentationURL string

+ GUID string

+ Metadata *Metadata

+ Name string

+ ServiceBrokerGUID string

+ ServiceBrokerName string

+ Tags types.OptionalStringSlice

+ func (s *ServiceOffering) UnmarshalJSON(data []byte) error

+ type ServicePlan struct

+ Available bool

+ Costs []ServicePlanCost

+ Description string

+ Free bool

+ GUID string

+ MaintenanceInfoDescription string

+ MaintenanceInfoVersion string

+ Metadata *Metadata

+ Name string

+ ServiceOfferingGUID string

+ SpaceGUID string

+ VisibilityType ServicePlanVisibilityType

+ func (p *ServicePlan) UnmarshalJSON(data []byte) error

+ type ServicePlanCost struct

+ Amount float64

+ Currency string

+ Unit string

+ type ServicePlanVisibility struct

+ Organizations []ServicePlanVisibilityDetail

+ Space ServicePlanVisibilityDetail

+ Type ServicePlanVisibilityType

+ func (s *ServicePlanVisibility) UnmarshalJSON(data []byte) error

+ func (s ServicePlanVisibility) MarshalJSON() ([]byte, error)

+ type ServicePlanVisibilityDetail struct

+ GUID string

+ Name string

+ func (s ServicePlanVisibilityDetail) OmitJSONry() bool

+ type ServicePlanVisibilityType string

+ const ServicePlanVisibilityAdmin

+ const ServicePlanVisibilityOrganization

+ const ServicePlanVisibilityPublic

+ const ServicePlanVisibilitySpace

+ type SharedToSpacesListWrapper struct

+ Organizations []Organization

+ SharedToSpaceGUIDs []string

+ Spaces []Space

+ func (s *SharedToSpacesListWrapper) UnmarshalJSON(data []byte) error

+ type Sidecar struct

+ Command types.FilteredString

+ GUID string

+ Name string

+ type Space struct

+ GUID string

+ Metadata *Metadata

+ Name string

+ Relationships Relationships

+ type SpaceFeature struct

+ Enabled bool

+ Name string

+ type SpaceQuota struct

+ OrgGUID string

+ SpaceGUIDs []string

+ func (sq *SpaceQuota) UnmarshalJSON(data []byte) error

+ func (sq SpaceQuota) MarshalJSON() ([]byte, error)

+ type Stack struct

+ Description string

+ GUID string

+ Metadata *Metadata

+ Name string

+ type Task struct

+ Command string

+ CreatedAt string

+ DiskInMB uint64

+ GUID string

+ LogRateLimitInBPS int

+ MemoryInMB uint64

+ Name string

+ Result *TaskResult

+ SequenceID int64

+ State constant.TaskState

+ Template *TaskTemplate

+ type TaskProcessTemplate struct

+ Guid string

+ type TaskResult struct

+ FailureReason string

+ type TaskTemplate struct

+ Process TaskProcessTemplate

+ type User struct

+ GUID string

+ Origin string

+ PresentationName string

+ Username string

Other modules containing this package

code.cloudfoundry.org/cli

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