models

Documentation

Index

• Constants
• Variables
• type AppFileFields
• type AppInstanceFields
• type AppParams
  • func (app *AppParams) IsEmpty() bool
  • func (app *AppParams) IsHostEmpty() 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) UrlForHostAndPath(host, path string, port int) string
• type Environment
  • func NewEnvironment() *Environment
• type EnvironmentVariable
• type EventFields
• type FeatureFlag
• type InstanceState
• type LastOperationFields
• type Organization
• type OrganizationFields
• type PluginRepo
• type QuotaFields
• type QuotaResponse
• type Route
  • func (r Route) URL() string
• type RoutePresenter
  • func (r *RoutePresenter) URL() string
• type RouteSummary
  • func (r RouteSummary) URL() string
• type RouterGroup
• type RouterGroups
• type SecurityGroup
• type SecurityGroupFields
• type SecurityGroupParams
• type ServiceAuthTokenFields
• type ServiceBindingFields
• type ServiceBindingRequest
• type ServiceBroker
• type ServiceInstance
  • func (inst ServiceInstance) IsUserProvided() bool
• type ServiceInstanceCreateRequest
• type ServiceInstanceFields
• type ServiceInstanceUpdateRequest
• type ServiceKey
• type ServiceKeyFields
• type ServiceKeyRequest
• 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
  • func (servicePlanFields ServicePlanFields) OrgHasVisibility(orgName string) bool
• type ServicePlanSummary
• type ServicePlanVisibilityFields
• type Space
• type SpaceFields
• type SpaceQuota
  • func (q SpaceQuota) FormattedAppInstanceLimit() string
  • func (q SpaceQuota) FormattedInstanceMemoryLimit() string
  • func (q SpaceQuota) FormattedMemoryLimit() string
• type SpaceQuotaResponse
• type Stack
• type UserFields
• type UserProvidedService
• type UserProvidedServiceEntity
• type UserProvidedServiceSummary

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
	Mode string
}

type AppInstanceFields

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

type AppParams

type AppParams struct {
	BuildpackUrl       *string
	Command            *string
	DiskQuota          *int64
	Domains            *[]string
	EnvironmentVars    *map[string]interface{}
	Guid               *string
	HealthCheckType    *string
	HealthCheckTimeout *int
	DockerImage        *string
	Diego              *bool
	EnableSsh          *bool
	Hosts              *[]string
	RoutePath          *string
	InstanceCount      *int
	Memory             *int64
	Name               *string
	NoHostname         bool
	NoRoute            bool
	UseRandomRoute     bool
	UseRandomPort      bool
	Path               *string
	ServicesToBind     *[]string
	SpaceGuid          *string
	StackGuid          *string
	StackName          *string
	State              *string
	PackageUpdatedAt   *time.Time
	AppPorts           *[]int
}

func (*AppParams) IsEmpty

func (app *AppParams) IsEmpty() bool

func (*AppParams) IsHostEmpty

func (app *AppParams) IsHostEmpty() bool

func (*AppParams) Merge

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

type Application

type Application struct {
	ApplicationFields
	Stack    *Stack
	Routes   []RouteSummary
	Services []ServicePlanSummary
}

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
	Diego                bool
	DetectedStartCommand string
	DiskQuota            int64 // in Megabytes
	EnvironmentVars      map[string]interface{}
	InstanceCount        int
	Memory               int64 // in Megabytes
	RunningInstances     int
	HealthCheckType      string
	HealthCheckTimeout   int
	State                string
	SpaceGuid            string
	StackGuid            string
	PackageUpdatedAt     *time.Time
	PackageState         string
	StagingFailedReason  string
	Buildpack            string
	DetectedBuildpack    string
	DockerImage          string
	EnableSsh            bool
	AppPorts             []int
}

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
	RouterGroupGuid        string
	RouterGroupType        string
	Shared                 bool
}

func (DomainFields) UrlForHostAndPath

func (model DomainFields) UrlForHostAndPath(host, path string, port int) string

type Environment

type Environment struct {
	System      map[string]interface{} `json:"system_env_json,omitempty"`
	Environment map[string]interface{} `json:"environment_json,omitempty"`
	Running     map[string]interface{} `json:"running_env_json,omitempty"`
	Staging     map[string]interface{} `json:"staging_env_json,omitempty"`
	Application map[string]interface{} `json:"application_env_json,omitempty"`
}

func NewEnvironment

func NewEnvironment() *Environment

type EnvironmentVariable

type EnvironmentVariable struct {
	Name  string
	Value string
}

type EventFields

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

type FeatureFlag

type FeatureFlag struct {
	Name         string `json:"name"`
	Enabled      bool   `json:"enabled"`
	ErrorMessage string `json:"error_message"`
}

type InstanceState

type InstanceState string

const (
	InstanceStarting InstanceState = "starting"
	InstanceRunning  InstanceState = "running"
	InstanceFlapping InstanceState = "flapping"
	InstanceDown     InstanceState = "down"
	InstanceCrashed  InstanceState = "crashed"
)

type LastOperationFields

type LastOperationFields struct {
	Type        string
	State       string
	Description string
	CreatedAt   string
	UpdatedAt   string
}

type Organization

type Organization struct {
	OrganizationFields
	Spaces      []SpaceFields
	Domains     []DomainFields
	SpaceQuotas []SpaceQuota
}

type OrganizationFields

type OrganizationFields struct {
	Guid            string
	Name            string
	QuotaDefinition QuotaFields
}

type PluginRepo

type PluginRepo struct {
	Name string
	Url  string
}

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

type QuotaResponse

type QuotaResponse struct {
	Guid                    string      `json:"guid,omitempty"`
	Name                    string      `json:"name"`
	MemoryLimit             int64       `json:"memory_limit"`          // in Megabytes
	InstanceMemoryLimit     int64       `json:"instance_memory_limit"` // in Megabytes
	RoutesLimit             int         `json:"total_routes"`
	ServicesLimit           int         `json:"total_services"`
	NonBasicServicesAllowed bool        `json:"non_basic_services_allowed"`
	AppInstanceLimit        json.Number `json:"app_instance_limit"`
}

type Route

type Route struct {
	Guid   string
	Host   string
	Domain DomainFields
	Path   string
	Port   int

	Space           SpaceFields
	Apps            []ApplicationFields
	ServiceInstance ServiceInstanceFields
}

func (Route) URL

func (r Route) URL() string

type RoutePresenter

type RoutePresenter struct {
	Host   string
	Domain string
	Path   string
	Port   int
}

func (*RoutePresenter) URL

func (r *RoutePresenter) URL() string

type RouteSummary

type RouteSummary struct {
	Guid   string
	Host   string
	Domain DomainFields
	Path   string
	Port   int
}

func (RouteSummary) URL

func (r RouteSummary) URL() string

type RouterGroup

type RouterGroup struct {
	Guid string `json:"guid"`
	Name string `json:"name"`
	Type string `json:"type"`
}

type RouterGroups

type RouterGroups []RouterGroup

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
	SpaceUrl string `json:"spaces_url,omitempty"`
	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 ServiceBindingRequest

type ServiceBindingRequest struct {
	AppGuid             string                 `json:"app_guid"`
	ServiceInstanceGuid string                 `json:"service_instance_guid"`
	Params              map[string]interface{} `json:"parameters,omitempty"`
}

type ServiceBroker

type ServiceBroker struct {
	Guid     string
	Name     string
	Username string
	Password string
	Url      string
	Services []ServiceOffering
}

type ServiceInstance

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

func (ServiceInstance) IsUserProvided

func (inst ServiceInstance) IsUserProvided() bool

type ServiceInstanceCreateRequest

type ServiceInstanceCreateRequest struct {
	Name      string                 `json:"name"`
	SpaceGuid string                 `json:"space_guid"`
	PlanGuid  string                 `json:"service_plan_guid,omitempty"`
	Params    map[string]interface{} `json:"parameters,omitempty"`
	Tags      []string               `json:"tags,omitempty"`
}

type ServiceInstanceFields

type ServiceInstanceFields struct {
	Guid             string
	Name             string
	LastOperation    LastOperationFields
	SysLogDrainUrl   string
	RouteServiceUrl  string
	ApplicationNames []string
	Params           map[string]interface{}
	DashboardUrl     string
	Tags             []string
}

type ServiceInstanceUpdateRequest

type ServiceInstanceUpdateRequest struct {
	PlanGuid string                 `json:"service_plan_guid,omitempty"`
	Params   map[string]interface{} `json:"parameters,omitempty"`
	Tags     []string               `json:"tags"`
}

type ServiceKey

type ServiceKey struct {
	Fields      ServiceKeyFields
	Credentials map[string]interface{}
}

type ServiceKeyFields

type ServiceKeyFields struct {
	Name                string
	Guid                string
	Url                 string
	ServiceInstanceGuid string
	ServiceInstanceUrl  string
}

type ServiceKeyRequest

type ServiceKeyRequest struct {
	Name                string                 `json:"name"`
	ServiceInstanceGuid string                 `json:"service_instance_guid"`
	Params              map[string]interface{} `json:"parameters,omitempty"`
}

type ServiceOffering

type ServiceOffering struct {
	ServiceOfferingFields
	Plans []ServicePlanFields
}

type ServiceOfferingFields

type ServiceOfferingFields struct {
	Guid             string
	BrokerGuid       string
	Label            string
	Provider         string
	Version          string
	Description      string
	DocumentationUrl string
	Requires         []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
	Free                bool
	Public              bool
	Description         string
	Active              bool
	ServiceOfferingGuid string
	OrgNames            []string
}

func (ServicePlanFields) OrgHasVisibility

func (servicePlanFields ServicePlanFields) OrgHasVisibility(orgName string) bool

type ServicePlanSummary

type ServicePlanSummary struct {
	Guid string
	Name string
}

type ServicePlanVisibilityFields

type ServicePlanVisibilityFields struct {
	Guid             string `json:"guid"`
	ServicePlanGuid  string `json:"service_plan_guid"`
	OrganizationGuid string `json:"organization_guid"`
}

type Space

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

type SpaceFields

type SpaceFields struct {
	Guid     string
	Name     string
	AllowSSH bool
}

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"` // in Megabytes
	RoutesLimit             int    `json:"total_routes"`
	ServicesLimit           int    `json:"total_services"`
	NonBasicServicesAllowed bool   `json:"non_basic_services_allowed"`
	OrgGuid                 string `json:"organization_guid"`
	AppInstanceLimit        int    `json:"app_instance_limit"`
}

func (SpaceQuota) FormattedAppInstanceLimit

func (q SpaceQuota) FormattedAppInstanceLimit() string

func (SpaceQuota) FormattedInstanceMemoryLimit

func (q SpaceQuota) FormattedInstanceMemoryLimit() string

func (SpaceQuota) FormattedMemoryLimit

func (q SpaceQuota) FormattedMemoryLimit() string

type SpaceQuotaResponse

type SpaceQuotaResponse struct {
	Guid                    string      `json:"guid,omitempty"`
	Name                    string      `json:"name"`
	MemoryLimit             int64       `json:"memory_limit"`          // in Megabytes
	InstanceMemoryLimit     int64       `json:"instance_memory_limit"` // in Megabytes
	RoutesLimit             int         `json:"total_routes"`
	ServicesLimit           int         `json:"total_services"`
	NonBasicServicesAllowed bool        `json:"non_basic_services_allowed"`
	OrgGuid                 string      `json:"organization_guid"`
	AppInstanceLimit        json.Number `json:"app_instance_limit"`
}

type Stack

type Stack struct {
	Guid        string
	Name        string
	Description string
}

type UserFields

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

type UserProvidedService

type UserProvidedService struct {
	Name            string                 `json:"name,omitempty"`
	Credentials     map[string]interface{} `json:"credentials"`
	SpaceGuid       string                 `json:"space_guid,omitempty"`
	SysLogDrainUrl  string                 `json:"syslog_drain_url"`
	RouteServiceUrl string                 `json:"route_service_url"`
}

type UserProvidedServiceEntity

type UserProvidedServiceEntity struct {
	UserProvidedService `json:"entity"`
}

type UserProvidedServiceSummary

type UserProvidedServiceSummary struct {
	Total     int                         `json:"total_results"`
	Resources []UserProvidedServiceEntity `json:"resources"`
}