broker

Documentation

Index

• type BindingIdParam
• type Broker
  • func New(p extension.ServiceProviderExtension) (*Broker, error)
  • func (b *Broker) Start(config Config)
• type BrokerErrorResponse
• type CatalogExtensionResponse
• type Config
  • func (c *Config) Initialize(cfEnv *cfenv.App)
• type InstanceIdParam
• type ServiceBindingResponse
• type ServiceCreationResponse
• type ServiceExtensionResponse
• type ServiceIdParam

Types

type BindingIdParam

type BindingIdParam struct {
	// Service binding GUID
	// in: path
	// required: true
	BindingId string `json:"binding_id"`
}

swagger:parameters bindService unbindService

type Broker

type Broker struct {
	// contains filtered or unexported fields
}

Broker represents a running CF Service Broker API

func New

func New(p extension.ServiceProviderExtension) (*Broker, error)

New creates a loaded instance of the broker

func (*Broker) Start

func (b *Broker) Start(config Config)

Start the broker

type BrokerErrorResponse

type BrokerErrorResponse struct {
	// Error description
	// in: body
	Body cf.BrokerError
}

Internal Server Error swagger:response brokerErrorResponse

type CatalogExtensionResponse

type CatalogExtensionResponse struct {
	// in: body
	Body extension.CatalogExtension
}

CatalogExtensionResponse swagger:response catalogExtensionResponse

type Config

type Config struct {
	CFEnv *cfenv.App
}

Config hold the broker configuration

func (*Config) Initialize

func (c *Config) Initialize(cfEnv *cfenv.App)

Initialize config with values from environment variables

type InstanceIdParam

type InstanceIdParam struct {
	// Service instance GUID
	// in: path
	// required: true
	InstanceId string `json:"instance_id"`
}

swagger:parameters provisionServiceInstance deprovisionServiceInstance bindService unbindService

type ServiceBindingResponse

type ServiceBindingResponse struct {
	// in: body
	Body types.ServiceBindingResponse
}

ServiceBindingResponse swagger:response serviceBindingResponse

type ServiceCreationResponse

type ServiceCreationResponse struct {
	// in: body
	Body cf.ServiceCreationResponse
}

ServiceCreationResponse swagger:response serviceCreationResponse

type ServiceExtensionResponse

type ServiceExtensionResponse struct {
	// in: body
	Body extension.ServiceExtension
}

ServiceExtensionResponse swagger:response serviceExtensionResponse

type ServiceIdParam

type ServiceIdParam struct {
	// Service GUID
	// in: path
	// required: true
	ServiceId string `json:"service_id"`
}

swagger:parameters updateService deleteService