models

Documentation

Index

• Constants
• Variables
• type AppFileFields
• type AppInstanceFields
• type AppParams
  • func (app *AppParams) IsEmpty() bool
  • func (app *AppParams) Merge(other *AppParams)
• type Application
  • func (model Application) HasRoute(route Route) bool
  • func (model Application) ToParams() (params AppParams)
• type ApplicationFields
• type Buildpack
• type DomainFields
  • func (model DomainFields) UrlForHost(host string) string
• type EventFields
• type InstanceState
• type Organization
• type OrganizationFields
• type QuotaFields
  • func NewQuotaFields(name string, memory uint64, routes int, services int, nonbasicservices bool) (q QuotaFields)
• type Route
  • func (route Route) URL() string
• type RouteSummary
  • func (model RouteSummary) URL() string
• type SecurityGroup
• type SecurityGroupFields
• type SecurityGroupParams
• type ServiceAuthTokenFields
• type ServiceBindingFields
• type ServiceBroker
• type ServiceInstance
  • func (inst ServiceInstance) IsUserProvided() bool
• type ServiceInstanceFields
• type ServiceOffering
• type ServiceOfferingFields
• type ServiceOfferings
  • func (s ServiceOfferings) Len() int
  • func (s ServiceOfferings) Less(i, j int) bool
  • func (s ServiceOfferings) Swap(i, j int)
• type ServicePlan
• type ServicePlanFields
• type Space
• type SpaceFields
• type Stack
• type UserFields

Constants

const (
	ORG_USER        = "OrgUser"
	ORG_MANAGER     = "OrgManager"
	BILLING_MANAGER = "BillingManager"
	ORG_AUDITOR     = "OrgAuditor"
	SPACE_MANAGER   = "SpaceManager"
	SPACE_DEVELOPER = "SpaceDeveloper"
	SPACE_AUDITOR   = "SpaceAuditor"
)

Variables

var SpaceRoleToUserInput = map[string]string{
	SPACE_MANAGER:   "SpaceManager",
	SPACE_DEVELOPER: "SpaceDeveloper",
	SPACE_AUDITOR:   "SpaceAuditor",
}

var UserInputToOrgRole = map[string]string{
	"OrgManager":     ORG_MANAGER,
	"BillingManager": BILLING_MANAGER,
	"OrgAuditor":     ORG_AUDITOR,
}

var UserInputToSpaceRole = map[string]string{
	"SpaceManager":   SPACE_MANAGER,
	"SpaceDeveloper": SPACE_DEVELOPER,
	"SpaceAuditor":   SPACE_AUDITOR,
}

Types

type AppFileFields

type AppFileFields struct {
	Path string
	Sha1 string
	Size int64
}

type AppInstanceFields

type AppInstanceFields struct {
	State     InstanceState
	Since     time.Time
	CpuUsage  float64 // percentage
	DiskQuota uint64  // in bytes
	DiskUsage uint64
	MemQuota  uint64
	MemUsage  uint64
}

type AppParams

type AppParams struct {
	BuildpackUrl       *string
	Command            *string
	DiskQuota          *uint64
	Domain             *string
	EnvironmentVars    *map[string]string
	Guid               *string
	HealthCheckTimeout *int
	Host               *string
	InstanceCount      *int
	Memory             *uint64
	Name               *string
	NoRoute            bool
	UseRandomHostname  bool
	Path               *string
	ServicesToBind     *[]string
	SpaceGuid          *string
	StackGuid          *string
	StackName          *string
	State              *string
}

func (*AppParams) IsEmpty

func (app *AppParams) IsEmpty() bool

func (*AppParams) Merge

func (app *AppParams) Merge(other *AppParams)

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 ApplicationFields struct {
	Guid             string
	Name             string
	BuildpackUrl     string
	Command          string
	DiskQuota        uint64 // in Megabytes
	EnvironmentVars  map[string]string
	InstanceCount    int
	Memory           uint64 // in Megabytes
	RunningInstances int
	State            string
	SpaceGuid        string
}

type Buildpack

type Buildpack struct {
	Guid     string
	Name     string
	Position *int
	Enabled  *bool
	Key      string
	Filename string
	Locked   *bool
}

type DomainFields

type DomainFields struct {
	Guid                   string
	Name                   string
	OwningOrganizationGuid string
	Shared                 bool
}

func (DomainFields) UrlForHost

func (model DomainFields) UrlForHost(host string) string

type EventFields

type EventFields struct {
	Guid        string
	Name        string
	Timestamp   time.Time
	Description string
	ActorName   string
}

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             uint64 `json:"memory_limit"` // in Megabytes
	RoutesLimit             int    `json:"total_routes"`
	ServicesLimit           int    `json:"total_services"`
	NonBasicServicesAllowed bool   `json:"non_basic_services_allowed"`
}

func NewQuotaFields

func NewQuotaFields(name string, memory uint64, routes int, services int, nonbasicservices bool) (q QuotaFields)

type Route

type Route struct {
	Guid   string
	Host   string
	Domain DomainFields

	Space SpaceFields
	Apps  []ApplicationFields
}

func (Route) URL

func (route Route) URL() string

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

type SecurityGroupFields struct {
	Name  string
	Guid  string
	Rules []map[string]interface{}
}

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 ServiceAuthTokenFields struct {
	Guid     string
	Label    string
	Provider string
	Token    string
}

type ServiceBindingFields

type ServiceBindingFields struct {
	Guid    string
	Url     string
	AppGuid string
}

type ServiceBroker

type ServiceBroker struct {
	Guid     string
	Name     string
	Username string
	Password string
	Url      string
}

type ServiceInstance

type ServiceInstance struct {
	ServiceInstanceFields
	ServiceBindings []ServiceBindingFields
	ServicePlan     ServicePlanFields
	ServiceOffering ServiceOfferingFields
}

func (ServiceInstance) IsUserProvided

func (inst ServiceInstance) IsUserProvided() bool

type ServiceInstanceFields

type ServiceInstanceFields struct {
	Guid             string
	Name             string
	SysLogDrainUrl   string
	ApplicationNames []string
	Params           map[string]interface{}
}

type ServiceOffering

type ServiceOffering struct {
	ServiceOfferingFields
	Plans []ServicePlanFields
}

type ServiceOfferingFields

type ServiceOfferingFields struct {
	Guid             string
	Label            string
	Provider         string
	Version          string
	Description      string
	DocumentationUrl string
}

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
}

type Space

type Space struct {
	SpaceFields
	Organization     OrganizationFields
	Applications     []ApplicationFields
	ServiceInstances []ServiceInstanceFields
	Domains          []DomainFields
	SecurityGroups   []SecurityGroupFields
}

type SpaceFields

type SpaceFields struct {
	Guid string
	Name string
}

type Stack

type Stack struct {
	Guid        string
	Name        string
	Description string
}

type UserFields

type UserFields struct {
	Guid     string
	Username string
	Password string
	IsAdmin  bool
}