composite

Documentation

Index

• type BrokerActor
• type GetAPIVersionActor
• type GetServiceInstanceActor
• type GetServicePlanActor
• type OrganizationActor
• type ServiceActor
• type ServiceBrokerSummaryCompositeActor
  • func (c *ServiceBrokerSummaryCompositeActor) GetServiceBrokerSummaries(brokerName string, serviceName string, organizationName string) ([]v2action.ServiceBrokerSummary, v2action.Warnings, error)
• type UpdateServiceInstanceCompositeActor
  • func (c UpdateServiceInstanceCompositeActor) CloudControllerAPIVersion() string
  • func (c UpdateServiceInstanceCompositeActor) GetServiceInstanceByNameAndSpace(name string, spaceGUID string) (v2action.ServiceInstance, v2action.Warnings, error)
  • func (c UpdateServiceInstanceCompositeActor) UpgradeServiceInstance(serviceInstanceGUID, servicePlanGUID string) (v2action.Warnings, error)
• type UpdateServiceInstanceMaintenanceInfoActor
• type VisibilityActor

Types

type BrokerActor

type BrokerActor interface {
	GetServiceBrokerByName(brokerName string) (v2action.ServiceBroker, v2action.Warnings, error)
	GetServiceBrokers() ([]v2action.ServiceBroker, v2action.Warnings, error)
}

type GetAPIVersionActor

type GetAPIVersionActor interface {
	CloudControllerAPIVersion() string
}

type GetServiceInstanceActor

type GetServiceInstanceActor interface {
	GetServiceInstanceByNameAndSpace(name string, spaceGUID string) (v2action.ServiceInstance, v2action.Warnings, error)
}

type GetServicePlanActor

type GetServicePlanActor interface {
	GetServicePlan(servicePlanGUID string) (v2action.ServicePlan, v2action.Warnings, error)
}

type OrganizationActor

type OrganizationActor interface {
	GetOrganization(organizationGUID string) (v2action.Organization, v2action.Warnings, error)
	OrganizationExistsWithName(organizationName string) (bool, v2action.Warnings, error)
}

type ServiceActor

type ServiceActor interface {
	GetServicesWithPlans(filters ...v2action.Filter) (v2action.ServicesWithPlans, v2action.Warnings, error)
	ServiceExistsWithName(serviceName string) (bool, v2action.Warnings, error)
}

type ServiceBrokerSummaryCompositeActor

type ServiceBrokerSummaryCompositeActor struct {
	ServiceActor    ServiceActor
	BrokerActor     BrokerActor
	OrgActor        OrganizationActor
	VisibilityActor VisibilityActor
}

func (*ServiceBrokerSummaryCompositeActor) GetServiceBrokerSummaries

func (c *ServiceBrokerSummaryCompositeActor) GetServiceBrokerSummaries(brokerName string, serviceName string, organizationName string) ([]v2action.ServiceBrokerSummary, v2action.Warnings, error)

GetServiceBrokerSummaries returns summaries for service brokers that match the arguments passed. An error will be returned if any of the options are invalid (i.e. there is no broker, service or organization with the given names). Consider the structure of Service Brokers, Services, and Plans as a tree (a Broker may have many Services, a Service may have many Plans) for the purpose of this explanation. Each of the provided arguments will act as a filtering mechanism, with the expectation that the caller does not want matches for "parent" concepts, if they have no "children" matching a filtered argument.

For example, given a Broker "Foo", only containing a Service "Bar":

`GetServiceBrokerSummaries("Foo", "NotBar", "")` will return a slice of broker summaries that does not include the Broker "Foo".

Similarly, given a broker "Foo", containing a Service "Bar", that has plans available only in Organization "Baz":

`GetServiceBrokerSummaries("Foo", "Bar", "NotBaz") will recurse upwards resulting in a slice of broker summaries that does not include the Broker "Foo" either.

type UpdateServiceInstanceCompositeActor

type UpdateServiceInstanceCompositeActor struct {
	GetServiceInstanceActor                   GetServiceInstanceActor
	GetServicePlanActor                       GetServicePlanActor
	UpdateServiceInstanceMaintenanceInfoActor UpdateServiceInstanceMaintenanceInfoActor
	GetAPIVersionActor                        GetAPIVersionActor
}

func (UpdateServiceInstanceCompositeActor) CloudControllerAPIVersion

func (c UpdateServiceInstanceCompositeActor) CloudControllerAPIVersion() string

CloudControllerAPIVersion returns the CloudController API version

func (UpdateServiceInstanceCompositeActor) GetServiceInstanceByNameAndSpace

func (c UpdateServiceInstanceCompositeActor) GetServiceInstanceByNameAndSpace(name string, spaceGUID string) (v2action.ServiceInstance, v2action.Warnings, error)

GetServiceInstanceByNameAndSpace gets the service instance by name and space guid provided

func (UpdateServiceInstanceCompositeActor) UpgradeServiceInstance

func (c UpdateServiceInstanceCompositeActor) UpgradeServiceInstance(serviceInstanceGUID, servicePlanGUID string) (v2action.Warnings, error)

UpgradeServiceInstance requests update on the service instance with the `maintenance_info` available on the plan

type UpdateServiceInstanceMaintenanceInfoActor

type UpdateServiceInstanceMaintenanceInfoActor interface {
	UpdateServiceInstanceMaintenanceInfo(serviceInsrtanceGUID string, maintenanceInfo v2action.MaintenanceInfo) (v2action.Warnings, error)
}

type VisibilityActor

type VisibilityActor interface {
	GetServicePlanVisibilities(planGUID string) ([]v2action.ServicePlanVisibility, v2action.Warnings, error)
}