Documentation ¶
Index ¶
- Constants
- Variables
- type AppFileFields
- type AppInstanceFields
- type AppParams
- type Application
- type ApplicationFields
- type Buildpack
- type DomainFields
- type EnvironmentVariable
- type EventFields
- type FeatureFlag
- type InstanceState
- type Organization
- type OrganizationFields
- type QuotaFields
- type Route
- type RouteSummary
- type SecurityGroup
- type SecurityGroupFields
- type SecurityGroupParams
- type ServiceAuthTokenFields
- type ServiceBindingFields
- type ServiceBroker
- type ServiceInstance
- type ServiceInstanceFields
- type ServiceOffering
- type ServiceOfferingFields
- type ServiceOfferings
- type ServicePlan
- type ServicePlanFields
- type ServicePlanVisibilityFields
- type Space
- type SpaceFields
- type SpaceQuota
- type Stack
- type UserFields
Constants ¶
View Source
const ( ORG_USER = "OrgUser" ORG_MANAGER = "OrgManager" BILLING_MANAGER = "BillingManager" ORG_AUDITOR = "OrgAuditor" SPACE_MANAGER = "SpaceManager" SPACE_DEVELOPER = "SpaceDeveloper" SPACE_AUDITOR = "SpaceAuditor" )
Variables ¶
View Source
var SpaceRoleToUserInput = map[string]string{ SPACE_MANAGER: "SpaceManager", SPACE_DEVELOPER: "SpaceDeveloper", SPACE_AUDITOR: "SpaceAuditor", }
View Source
var UserInputToOrgRole = map[string]string{ "OrgManager": ORG_MANAGER, "BillingManager": BILLING_MANAGER, "OrgAuditor": ORG_AUDITOR, }
View Source
var UserInputToSpaceRole = map[string]string{ "SpaceManager": SPACE_MANAGER, "SpaceDeveloper": SPACE_DEVELOPER, "SpaceAuditor": SPACE_AUDITOR, }
Functions ¶
This section is empty.
Types ¶
type AppFileFields ¶
type AppInstanceFields ¶
type AppParams ¶
type AppParams struct { BuildpackUrl *string Command *string DiskQuota *int64 Domain *string EnvironmentVars *map[string]string Guid *string HealthCheckTimeout *int Host *string InstanceCount *int Memory *int64 Name *string NoRoute bool UseRandomHostname bool Path *string ServicesToBind *[]string SpaceGuid *string StackGuid *string StackName *string State *string }
type Application ¶
type Application struct { ApplicationFields Stack *Stack Routes []RouteSummary }
func (Application) HasRoute ¶
func (model Application) HasRoute(route Route) bool
func (Application) ToParams ¶
func (model Application) ToParams() (params AppParams)
type ApplicationFields ¶
type DomainFields ¶
func (DomainFields) UrlForHost ¶
func (model DomainFields) UrlForHost(host string) string
type EnvironmentVariable ¶
func NewEnvironmentVariable ¶
func NewEnvironmentVariable(name string, value string) (e EnvironmentVariable)
type EventFields ¶
type FeatureFlag ¶
type FeatureFlag struct { Name string `json:"name"` Enabled bool `json:"enabled"` ErrorMessage string `json:"error_message"` }
func NewFeatureFlag ¶
func NewFeatureFlag(name string, enabled bool, errorMessage string) (f FeatureFlag)
type InstanceState ¶
type InstanceState string
const ( InstanceStarting InstanceState = "starting" InstanceRunning InstanceState = "running" InstanceFlapping InstanceState = "flapping" InstanceDown InstanceState = "down" )
type Organization ¶
type Organization struct { OrganizationFields Spaces []SpaceFields Domains []DomainFields }
type OrganizationFields ¶
type OrganizationFields struct { Guid string Name string QuotaDefinition QuotaFields }
type QuotaFields ¶
type QuotaFields struct { Guid string `json:"guid,omitempty"` Name string `json:"name"` MemoryLimit int64 `json:"memory_limit"` // in Megabytes InstanceMemoryLimit int64 `json:"instance_memory_limit,omitempty"` // in Megabytes RoutesLimit int `json:"total_routes"` ServicesLimit int `json:"total_services"` NonBasicServicesAllowed bool `json:"non_basic_services_allowed"` }
func NewQuotaFields ¶
type Route ¶
type Route struct { Guid string Host string Domain DomainFields Space SpaceFields Apps []ApplicationFields }
type RouteSummary ¶
type RouteSummary struct { Guid string Host string Domain DomainFields }
func (RouteSummary) URL ¶
func (model RouteSummary) URL() string
type SecurityGroup ¶
type SecurityGroup struct { SecurityGroupFields Spaces []Space }
represents a fully instantiated model returned by the CC (e.g.: with its attributes and the fields for its child objects)
type SecurityGroupFields ¶
represents just the attributes for an security group
type SecurityGroupParams ¶
type SecurityGroupParams struct { Name string `json:"name,omitempty"` Guid string `json:"guid,omitempty"` Rules []map[string]interface{} `json:"rules"` }
represents the JSON that we send up to CC when the user creates / updates a record
type ServiceAuthTokenFields ¶
type ServiceBindingFields ¶
type ServiceBroker ¶
type ServiceInstance ¶
type ServiceInstance struct { ServiceInstanceFields ServiceBindings []ServiceBindingFields ServicePlan ServicePlanFields ServiceOffering ServiceOfferingFields }
func (ServiceInstance) IsUserProvided ¶
func (inst ServiceInstance) IsUserProvided() bool
type ServiceInstanceFields ¶
type ServiceOffering ¶
type ServiceOffering struct { ServiceOfferingFields Plans []ServicePlanFields }
type ServiceOfferingFields ¶
type ServiceOfferings ¶
type ServiceOfferings []ServiceOffering
func (ServiceOfferings) Len ¶
func (s ServiceOfferings) Len() int
func (ServiceOfferings) Less ¶
func (s ServiceOfferings) Less(i, j int) bool
func (ServiceOfferings) Swap ¶
func (s ServiceOfferings) Swap(i, j int)
type ServicePlan ¶
type ServicePlan struct { ServicePlanFields ServiceOffering ServiceOfferingFields }
type ServicePlanFields ¶
type ServicePlanFields struct { Guid string Name string Free bool Public bool Description string Active bool ServiceOfferingGuid string OrgNames []string }
func (ServicePlanFields) OrgHasVisibility ¶
func (servicePlanFields ServicePlanFields) OrgHasVisibility(orgName string) bool
type Space ¶
type Space struct { SpaceFields Organization OrganizationFields Applications []ApplicationFields ServiceInstances []ServiceInstanceFields Domains []DomainFields SecurityGroups []SecurityGroupFields SpaceQuotaGuid string }
type SpaceFields ¶
type SpaceQuota ¶
type SpaceQuota struct { Guid string `json:"guid,omitempty"` Name string `json:"name"` MemoryLimit int64 `json:"memory_limit"` // in Megabytes InstanceMemoryLimit int64 `json:"instance_memory_limit,omitempty"` // in Megabytes RoutesLimit int `json:"total_routes"` ServicesLimit int `json:"total_services"` NonBasicServicesAllowed bool `json:"non_basic_services_allowed"` OrgGuid string `json:"organization_guid"` }
func NewSpaceQuota ¶
Source Files ¶
- app_event.go
- app_file.go
- app_instance.go
- application.go
- buildpack.go
- domain.go
- environment_variable.go
- feature_flag.go
- organization.go
- quota.go
- route.go
- security_group.go
- service_auth_token.go
- service_binding.go
- service_broker.go
- service_instance.go
- service_offering.go
- service_plan.go
- service_plan_visibility.go
- space.go
- space_quota.go
- stack.go
- user.go
- user_roles.go
Click to show internal directories.
Click to hide internal directories.