plugin_models

Documentation

Index

• type AppInstanceFields
• type Application
• type ApplicationFields
• type ApplicationSummary
• type DomainFields
• type LastOperationFields
• type Organization
• type OrganizationSummary
• type QuotaFields
• type RouteSummary
• type SecurityGroupFields
• type ServiceFields
• type ServiceInstance
• type ServiceInstanceSummary
• type ServicePlanFields
• type ServicePlanSummary
• type Space
• type SpaceQuotaFields
• type SpaceSummary
• type Stack
• type User

Types

type AppInstanceFields

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

type Application

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

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
	HealthCheckTimeout   int
	State                string
	SpaceGuid            string
	PackageUpdatedAt     *time.Time
	PackageState         string
	StagingFailedReason  string
	Instances            []AppInstanceFields
}

type ApplicationSummary

type ApplicationSummary struct {
	Name             string
	Guid             string
	State            string
	TotalInstances   int
	RunningInstances int
	Memory           int64
	DiskQuota        int64
	Routes           []RouteSummary
}

type DomainFields

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

type LastOperationFields

type LastOperationFields struct {
	Type        string
	State       string
	Description string
}

type Organization

type Organization struct {
	Guid            string
	Name            string
	QuotaDefinition QuotaFields
	Spaces          []SpaceSummary
	Domains         []DomainFields
	SpaceQuotas     []SpaceQuotaFields
}

type OrganizationSummary

type OrganizationSummary struct {
	Guid string
	Name string
}

type QuotaFields

type QuotaFields struct {
	Guid                    string
	Name                    string
	MemoryLimit             int64
	InstanceMemoryLimit     int64
	RoutesLimit             int
	ServicesLimit           int
	NonBasicServicesAllowed bool
}

type RouteSummary

type RouteSummary struct {
	Guid   string
	Host   string
	Domain DomainFields
}

type SecurityGroupFields

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

represents just the attributes for an security group

type ServiceFields

type ServiceFields struct {
	Name string
}

type ServiceInstance

type ServiceInstance struct {
	Guid             string
	Name             string
	ServicePlan      ServicePlanFields
	Service          ServiceFields
	LastOperation    LastOperationFields
	ApplicationNames []string
	IsUserProvided   bool
}

type ServiceInstanceSummary

type ServiceInstanceSummary struct {
	Guid string
	Name string
}

type ServicePlanFields

type ServicePlanFields struct {
	Guid string
	Name string
}

type ServicePlanSummary

type ServicePlanSummary struct {
	Guid string
	Name string
}

type Space

type Space struct {
	SpaceSummary
	Organization     OrganizationSummary
	Applications     []ApplicationSummary
	ServiceInstances []ServiceInstanceSummary
	Domains          []DomainFields
	SecurityGroups   []SecurityGroupFields
	SpaceQuota       SpaceQuotaFields
}

type SpaceQuotaFields

type SpaceQuotaFields struct {
	Guid                    string
	Name                    string
	MemoryLimit             int64
	InstanceMemoryLimit     int64
	RoutesLimit             int
	ServicesLimit           int
	NonBasicServicesAllowed bool
}

type SpaceSummary

type SpaceSummary struct {
	Guid string
	Name string
}

type Stack

type Stack struct {
	Guid        string
	Name        string
	Description string
}

type User

type User struct {
	Guid     string
	Username string
	IsAdmin  bool
	Roles    []string
}