Documentation ¶
Index ¶
- Constants
- Variables
- func AttachRoutes(router *mux.Router, serviceBroker ServiceBroker, logger lager.Logger)
- func FreeValue(v bool) *bool
- func New(serviceBroker ServiceBroker, logger lager.Logger, ...) http.Handler
- type BindDetails
- type BindResource
- type Binding
- type BrokerCredentials
- type CatalogResponse
- type DeprovisionDetails
- type EmptyResponse
- type ErrorResponse
- type IsAsync
- type LastOperation
- type LastOperationResponse
- type LastOperationState
- type PreviousValues
- type ProvisionDetails
- type ProvisionedServiceSpec
- type ProvisioningResponse
- type RequiredPermission
- type Service
- type ServiceBroker
- type ServiceCost
- type ServiceDashboardClient
- type ServiceMetadata
- type ServicePlan
- type ServicePlanMetadata
- type UnbindDetails
- type UpdateDetails
Constants ¶
View Source
const ( PermissionRouteForwarding = RequiredPermission("route_forwarding") PermissionSyslogDrain = RequiredPermission("syslog_drain") )
Variables ¶
View Source
var ( ErrInstanceAlreadyExists = errors.New("instance already exists") ErrInstanceDoesNotExist = errors.New("instance does not exist") ErrInstanceLimitMet = errors.New("instance limit for this service has been reached") ErrBindingAlreadyExists = errors.New("binding already exists") ErrBindingDoesNotExist = errors.New("binding does not exist") ErrAsyncRequired = errors.New("This service plan requires client support for asynchronous service operations.") ErrPlanChangeNotSupported = errors.New("The requested plan migration cannot be performed") ErrProvisionParametersInvalid = errors.New("provisioning parameters are invalid") )
Functions ¶
func AttachRoutes ¶
func AttachRoutes(router *mux.Router, serviceBroker ServiceBroker, logger lager.Logger)
func New ¶
func New(serviceBroker ServiceBroker, logger lager.Logger, brokerCredentials BrokerCredentials) http.Handler
Types ¶
type BindDetails ¶
type BindDetails struct { AppGUID string `json:"app_guid"` PlanID string `json:"plan_id"` ServiceID string `json:"service_id"` BindResource *BindResource `json:"bind_resource,omitempty"` Parameters map[string]interface{} `json:"parameters,omitempty"` }
type BindResource ¶
type Binding ¶
type Binding struct { Credentials interface{} `json:"credentials"` SyslogDrainURL string `json:"syslog_drain_url,omitempty"` }
type BrokerCredentials ¶
type CatalogResponse ¶
type CatalogResponse struct {
Services []Service `json:"services"`
}
type DeprovisionDetails ¶
type EmptyResponse ¶
type EmptyResponse struct{}
type ErrorResponse ¶
type LastOperation ¶
type LastOperation struct { State LastOperationState Description string }
type LastOperationResponse ¶
type LastOperationState ¶
type LastOperationState string
const ( InProgress LastOperationState = "in progress" Succeeded LastOperationState = "succeeded" Failed LastOperationState = "failed" )
type PreviousValues ¶
type ProvisionDetails ¶
type ProvisionedServiceSpec ¶
type ProvisioningResponse ¶
type ProvisioningResponse struct {
DashboardURL string `json:"dashboard_url,omitempty"`
}
type RequiredPermission ¶
type RequiredPermission string
type Service ¶
type Service struct { ID string `json:"id"` Name string `json:"name"` Description string `json:"description"` Bindable bool `json:"bindable"` Tags []string `json:"tags,omitempty"` PlanUpdatable bool `json:"plan_updateable"` Plans []ServicePlan `json:"plans"` Requires []RequiredPermission `json:"requires,omitempty"` Metadata *ServiceMetadata `json:"metadata,omitempty"` DashboardClient *ServiceDashboardClient `json:"dashboard_client,omitempty"` }
type ServiceBroker ¶
type ServiceBroker interface { Services() []Service Provision(instanceID string, details ProvisionDetails, asyncAllowed bool) (ProvisionedServiceSpec, error) Deprovision(instanceID string, details DeprovisionDetails, asyncAllowed bool) (IsAsync, error) Bind(instanceID, bindingID string, details BindDetails) (Binding, error) Unbind(instanceID, bindingID string, details UnbindDetails) error Update(instanceID string, details UpdateDetails, asyncAllowed bool) (IsAsync, error) LastOperation(instanceID string) (LastOperation, error) }
type ServiceCost ¶
type ServiceDashboardClient ¶
type ServiceMetadata ¶
type ServiceMetadata struct { DisplayName string `json:"displayName,omitempty"` ImageUrl string `json:"imageUrl,omitempty"` LongDescription string `json:"longDescription,omitempty"` ProviderDisplayName string `json:"providerDisplayName,omitempty"` DocumentationUrl string `json:"documentationUrl,omitempty"` SupportUrl string `json:"supportUrl,omitempty"` }
type ServicePlan ¶
type ServicePlan struct { ID string `json:"id"` Name string `json:"name"` Description string `json:"description"` Free *bool `json:"free,omitempty"` Metadata *ServicePlanMetadata `json:"metadata,omitempty"` }
type ServicePlanMetadata ¶
type ServicePlanMetadata struct { DisplayName string `json:"displayName,omitempty"` Bullets []string `json:"bullets,omitempty"` Costs []ServiceCost `json:"costs,omitempty"` }
type UnbindDetails ¶
type UpdateDetails ¶
type UpdateDetails struct { ServiceID string `json:"service_id"` PlanID string `json:"plan_id"` Parameters map[string]interface{} `json:"parameters"` PreviousValues PreviousValues `json:"previous_values"` }
Directories ¶
Path | Synopsis |
---|---|
Godeps
|
|
_workspace/src/github.com/gorilla/context
Package context stores values shared during a request lifetime.
|
Package context stores values shared during a request lifetime. |
_workspace/src/github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
|
Package gorilla/mux implements a request router and dispatcher. |
_workspace/src/github.com/onsi/ginkgo
Ginkgo is a BDD-style testing framework for Golang The godoc documentation describes Ginkgo's API.
|
Ginkgo is a BDD-style testing framework for Golang The godoc documentation describes Ginkgo's API. |
_workspace/src/github.com/onsi/ginkgo/config
Ginkgo accepts a number of configuration options.
|
Ginkgo accepts a number of configuration options. |
_workspace/src/github.com/onsi/ginkgo/ginkgo
The Ginkgo CLI The Ginkgo CLI is fully documented [here](http://onsi.github.io/ginkgo/#the_ginkgo_cli) You can also learn more by running: ginkgo help Here are some of the more commonly used commands: To install: go install github.com/onsi/ginkgo/ginkgo To run tests: ginkgo To run tests in all subdirectories: ginkgo -r To run tests in particular packages: ginkgo <flags> /path/to/package /path/to/another/package To pass arguments/flags to your tests: ginkgo <flags> <packages> -- <pass-throughs> To run tests in parallel ginkgo -p this will automatically detect the optimal number of nodes to use.
|
The Ginkgo CLI The Ginkgo CLI is fully documented [here](http://onsi.github.io/ginkgo/#the_ginkgo_cli) You can also learn more by running: ginkgo help Here are some of the more commonly used commands: To install: go install github.com/onsi/ginkgo/ginkgo To run tests: ginkgo To run tests in all subdirectories: ginkgo -r To run tests in particular packages: ginkgo <flags> /path/to/package /path/to/another/package To pass arguments/flags to your tests: ginkgo <flags> <packages> -- <pass-throughs> To run tests in parallel ginkgo -p this will automatically detect the optimal number of nodes to use. |
_workspace/src/github.com/onsi/ginkgo/internal/remote
Aggregator is a reporter used by the Ginkgo CLI to aggregate and present parallel test output coherently as tests complete.
|
Aggregator is a reporter used by the Ginkgo CLI to aggregate and present parallel test output coherently as tests complete. |
_workspace/src/github.com/onsi/ginkgo/reporters
Ginkgo's Default Reporter A number of command line flags are available to tweak Ginkgo's default output.
|
Ginkgo's Default Reporter A number of command line flags are available to tweak Ginkgo's default output. |
_workspace/src/github.com/onsi/gomega
Gomega is the Ginkgo BDD-style testing framework's preferred matcher library.
|
Gomega is the Ginkgo BDD-style testing framework's preferred matcher library. |
_workspace/src/github.com/onsi/gomega/format
Gomega's format package pretty-prints objects.
|
Gomega's format package pretty-prints objects. |
_workspace/src/github.com/onsi/gomega/gbytes
Package gbytes provides a buffer that supports incrementally detecting input.
|
Package gbytes provides a buffer that supports incrementally detecting input. |
_workspace/src/github.com/onsi/gomega/gexec
Package gexec provides support for testing external processes.
|
Package gexec provides support for testing external processes. |
_workspace/src/github.com/onsi/gomega/ghttp
Package ghttp supports testing HTTP clients by providing a test server (simply a thin wrapper around httptest's server) that supports registering multiple handlers.
|
Package ghttp supports testing HTTP clients by providing a test server (simply a thin wrapper around httptest's server) that supports registering multiple handlers. |
_workspace/src/github.com/onsi/gomega/ghttp/protobuf
Package protobuf is a generated protocol buffer package.
|
Package protobuf is a generated protocol buffer package. |
_workspace/src/github.com/onsi/gomega/matchers
Gomega matchers This package implements the Gomega matchers and does not typically need to be imported.
|
Gomega matchers This package implements the Gomega matchers and does not typically need to be imported. |
_workspace/src/github.com/pborman/uuid
The uuid package generates and inspects UUIDs.
|
The uuid package generates and inspects UUIDs. |
Click to show internal directories.
Click to hide internal directories.