types

Documentation

Index

• Constants
• Variables
• type CfApp
• type CfAppInstance
• type CfAppResource
  • func NewCfAppResource(summary CfAppSummary, newName string, spaceGUID string) *CfAppResource
• type CfAppSummary
• type CfAppSummaryRoute
• type CfAppSummaryService
• type CfAppSummaryServicePlan
• type CfAppSummaryServicePlanService
• type CfAppsResponse
• type CfBinding
• type CfBindingResource
• type CfBindingsResources
• type CfCopyBitsRequest
• type CfCreateRouteRequest
• type CfDomain
• type CfDomainResponse
• type CfJob
• type CfJobResponse
• type CfMeta
• type CfRoute
• type CfRouteResource
• type CfRoutesResponse
• type CfService
• type CfServiceBindingCreateRequest
  • func NewCfServiceBindingRequest(appGUID string, svcInstanceGUID string) *CfServiceBindingCreateRequest
• type CfServiceBindingCreateResponse
• type CfServiceBroker
• type CfServiceBrokerResource
• type CfServiceBrokerResources
• type CfServiceContext
• type CfServiceInstanceCreateRequest
  • func NewCfServiceInstanceRequest(name string, spaceGUID string, plan CfAppSummaryServicePlan) *CfServiceInstanceCreateRequest
• type CfServiceInstanceCreateResponse
• type CfServicePlanResource
• type CfServicePlansResources
• type CfServiceResource
• type CfServicesResources
• type CfSpace
• type CfSpaceResource
• type CfUserProvidedService
• type CfUserProvidedServiceResource
• type CfVcapApplication
• type Component
• type ComponentClone
• type ComponentType
• type ServiceBindingResponse

Constants

const (
	AppStarted = "STARTED"
	AppStopped = "STOPPED"
)

const (
	ComponentService ComponentType = "Service"
	ComponentUPS                   = "User provided service"
	ComponentApp                   = "Application"
)

Variables

var CcCreateAppFailedError = errors.New("Error occurred while creating new app")

var CcGetInstancesFailedError = errors.New("Error occurred while getting app instances")

var CcJobFailedError = errors.New("Error occurred while copying bits")

var CcRestageFailedError = errors.New("Error occurred while restaging")

var CcUpdateFailedError = errors.New("Error occurred while app updating")

var EntityNotFoundError = errors.New("Entity does not exist")

var ExistingInstancesError = errors.New("Can't remove service with existing instances from catalog")

var InstanceAlreadyExistsError = errors.New("Such an instance already exists")

var InstanceNotFoundError = errors.New("No such instance exists")

var InternalServerError = errors.New("Some internal error occurred")

var InvalidInputError error = errors.New("Invalid request body")

var ServiceAlreadyExistsError = errors.New("Service already exists")

var ServiceNotFoundError = errors.New("No such service exists")

var TimeoutOccurredError = errors.New("Asynchronous call timeouted")

Types

type CfApp

type CfApp struct {
	Name          string                 `json:"name"`
	SpaceGUID     string                 `json:"space_guid"`
	RoutesURL     string                 `json:"routes_url"`
	State         string                 `json:"state"`
	BuildpackUrl  string                 `json:"buildpack"`
	Command       string                 `json:"command"`
	DiskQuota     int64                  `json:"disk_quota"`
	InstanceCount int                    `json:"instances"`
	Memory        int64                  `json:"memory"`
	Path          string                 `json:"path"`
	Envs          map[string]interface{} `json:"environment_json"`
}

type CfAppInstance

type CfAppInstance struct {
	State string  `json:"state"`
	Since float64 `json:"since"`
}

type CfAppResource

type CfAppResource struct {
	Meta   CfMeta `json:"metadata"`
	Entity CfApp  `json:"entity"`
}

func NewCfAppResource

func NewCfAppResource(summary CfAppSummary, newName string, spaceGUID string) *CfAppResource

type CfAppSummary

type CfAppSummary struct {
	CfApp
	GUID     string                `json:"guid"`
	Routes   []CfAppSummaryRoute   `json:"routes"`
	Services []CfAppSummaryService `json:"services"`
}

type CfAppSummaryRoute

type CfAppSummaryRoute struct {
	GUID   string   `json:"guid"`
	Host   string   `json:"host"`
	Domain CfDomain `json:"domain"`
}

type CfAppSummaryService

type CfAppSummaryService struct {
	GUID string                  `json:"guid"`
	Name string                  `json:"name"`
	Plan CfAppSummaryServicePlan `json:"service_plan"`
}

type CfAppSummaryServicePlan

type CfAppSummaryServicePlan struct {
	GUID    string `json:"guid"`
	Name    string `json:"name"`
	Service CfAppSummaryServicePlanService
}

type CfAppSummaryServicePlanService

type CfAppSummaryServicePlanService struct {
	GUID  string `json:"guid"`
	Label string `json:"label"`
}

type CfAppsResponse

type CfAppsResponse struct {
	Count     int             `json:"total_results"`
	Pages     int             `json:"total_pages"`
	Resources []CfAppResource `json:"resources"`
}

cfAppsResponse describes the Cloud Controller API result for a list of apps

type CfBinding

type CfBinding struct {
	GUID                string `json:"guid"`
	AppGUID             string `json:"app_guid"`
	ServiceInstanceGUID string `json:"service_instance_guid"`
}

CFBindingResponse describes a CF Service Binding within the Cloud Controller

type CfBindingResource

type CfBindingResource struct {
	Meta   CfMeta    `json:"metadata"`
	Entity CfBinding `json:"entity"`
}

type CfBindingsResources

type CfBindingsResources struct {
	TotalResults int                 `json:"total_results"`
	Resources    []CfBindingResource `json:"resources"`
}

type CfCopyBitsRequest

type CfCopyBitsRequest struct {
	SrcAppGUID string `json:"source_app_guid"`
}

type CfCreateRouteRequest

type CfCreateRouteRequest struct {
	Host       string `json:"host"`
	DomainGUID string `json:"domain_guid"`
	SpaceGUID  string `json:"space_guid"`
}

type CfDomain

type CfDomain struct {
	GUID string `json:"guid"`
	Name string `json:"name"`
}

type CfDomainResponse

type CfDomainResponse struct {
	Meta   CfMeta   `json:"metadata"`
	Entity CfDomain `json:"entity"`
}

type CfJob

type CfJob struct {
	GUID   string `json:"guid"`
	Status string `json:"status"`
	Error  string `json:"error"`
}

type CfJobResponse

type CfJobResponse struct {
	Meta   CfMeta `json:"metadata"`
	Entity CfJob  `json:"entity"`
}

type CfMeta

type CfMeta struct {
	GUID string `json:"guid"`
	URL  string `json:"url"`
}

type CfRoute

type CfRoute struct {
	Host       string `json:"host"`
	DomainURL  string `json:"domain_url"`
	DomainGUID string `json:"domain_guid"`
}

type CfRouteResource

type CfRouteResource struct {
	Meta   CfMeta  `json:"metadata"`
	Entity CfRoute `json:"entity"`
}

type CfRoutesResponse

type CfRoutesResponse struct {
	Count     int               `json:"total_results"`
	Pages     int               `json:"total_pages"`
	Resources []CfRouteResource `json:"resources"`
}

type CfService

type CfService struct {
	Name       string `json:"label"`
	Provider   string `json:"provider"`
	PlansURL   string `json:"service_plans_url"`
	BrokerGUID string `json:"service_broker_guid"`
}

type CfServiceBindingCreateRequest

type CfServiceBindingCreateRequest struct {
	ServiceInstanceGUID string                 `json:"service_instance_guid"`
	AppGUID             string                 `json:"app_guid"`
	Params              map[string]interface{} `json:"parameters,omitempty"`
}

func NewCfServiceBindingRequest

func NewCfServiceBindingRequest(appGUID string, svcInstanceGUID string) *CfServiceBindingCreateRequest

type CfServiceBindingCreateResponse

type CfServiceBindingCreateResponse struct {
	Meta CfMeta `json:"metadata"`
}

type CfServiceBroker

type CfServiceBroker struct {
	Name     string `json:"name,omitempty"`
	URL      string `json:"broker_url"`
	Username string `json:"auth_username"`
	Password string `json:"auth_password"`
}

type CfServiceBrokerResource

type CfServiceBrokerResource struct {
	Meta   CfMeta          `json:"metadata"`
	Entity CfServiceBroker `json:"entity"`
}

type CfServiceBrokerResources

type CfServiceBrokerResources struct {
	TotalResults int                       `json:"total_results"`
	Resources    []CfServiceBrokerResource `json:"resources"`
}

type CfServiceContext

type CfServiceContext struct {
	InstanceID   string
	OrgName      string
	SpaceName    string
	SpaceGUID    string
	InstanceName string
	AppName      string
}

CfServiceContext describes a CF Service Instance within the Cloud Controller

type CfServiceInstanceCreateRequest

type CfServiceInstanceCreateRequest 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"`
}

func NewCfServiceInstanceRequest

func NewCfServiceInstanceRequest(name string, spaceGUID string, plan CfAppSummaryServicePlan) *CfServiceInstanceCreateRequest

type CfServiceInstanceCreateResponse

type CfServiceInstanceCreateResponse struct {
	Meta CfMeta `json:"metadata"`
}

type CfServicePlanResource

type CfServicePlanResource struct {
	Meta   CfMeta                  `json:"metadata"`
	Entity CfAppSummaryServicePlan `json:"entity"`
}

type CfServicePlansResources

type CfServicePlansResources struct {
	TotalResults int                     `json:"total_results"`
	Resources    []CfServicePlanResource `json:"resources"`
}

type CfServiceResource

type CfServiceResource struct {
	Meta   CfMeta    `json:"metadata"`
	Entity CfService `json:"entity"`
}

type CfServicesResources

type CfServicesResources struct {
	TotalResults int                 `json:"total_results"`
	Resources    []CfServiceResource `json:"resources"`
}

type CfSpace

type CfSpace struct {
	GUID    string `json:"guid"`
	Name    string `json:"name"`
	OrgGUID string `json:"organization_guid"`
}

type CfSpaceResource

type CfSpaceResource struct {
	Meta   CfMeta  `json:"metadata"`
	Entity CfSpace `json:"entity"`
}

type CfUserProvidedService

type CfUserProvidedService struct {
	Name            string                 `json:"name"`
	SpaceGUID       string                 `json:"space_guid"`
	SyslogDrainURL  string                 `json:"syslog_drain_url,omitempty"`
	Credentials     map[string]interface{} `json:"credentials,omitempty"`
	RouteServiceURL string                 `json:"route_service_url,omitempty"`
}

type CfUserProvidedServiceResource

type CfUserProvidedServiceResource struct {
	Meta   CfMeta                `json:"metadata"`
	Entity CfUserProvidedService `json:"entity"`
}

type CfVcapApplication

type CfVcapApplication struct {
	Name string   `json:"name"`
	Uris []string `json:"uris"`
}

type Component

type Component struct {
	GUID         string        `json:"GUID"`
	Name         string        `json:"name"`
	Type         ComponentType `json:"type"`
	DependencyOf []string      `json:"dependencyOf"`
	Clone        bool          `json:"clone"`
}

type ComponentClone

type ComponentClone struct {
	Component Component `json:"component"`
	CloneGUID string    `json:"cloneGUID"`
}

type ComponentType

type ComponentType string

type ServiceBindingResponse

type ServiceBindingResponse struct {
	Credentials map[string]string `json:"credentials"`
}