Documentation
¶
Index ¶
- type BrokerAPI
- func (o *BrokerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *BrokerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *BrokerAPI) DefaultConsumes() string
- func (o *BrokerAPI) DefaultProduces() string
- func (o *BrokerAPI) Formats() strfmt.Registry
- func (o *BrokerAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *BrokerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *BrokerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *BrokerAPI) Serve(builder middleware.Builder) http.Handler
- func (o *BrokerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *BrokerAPI) SetDefaultConsumes(mediaType string)
- func (o *BrokerAPI) SetDefaultProduces(mediaType string)
- func (o *BrokerAPI) Validate() error
- type CreateServiceInstance
- type CreateServiceInstanceAccepted
- func (o *CreateServiceInstanceAccepted) SetPayload(payload *brokermodel.DashboardURL)
- func (o *CreateServiceInstanceAccepted) WithPayload(payload *brokermodel.DashboardURL) *CreateServiceInstanceAccepted
- func (o *CreateServiceInstanceAccepted) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceInstanceConflict
- type CreateServiceInstanceCreated
- func (o *CreateServiceInstanceCreated) SetPayload(payload *brokermodel.DashboardURL)
- func (o *CreateServiceInstanceCreated) WithPayload(payload *brokermodel.DashboardURL) *CreateServiceInstanceCreated
- func (o *CreateServiceInstanceCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceInstanceDefault
- func (o *CreateServiceInstanceDefault) SetPayload(payload *brokermodel.BrokerError)
- func (o *CreateServiceInstanceDefault) SetStatusCode(code int)
- func (o *CreateServiceInstanceDefault) WithPayload(payload *brokermodel.BrokerError) *CreateServiceInstanceDefault
- func (o *CreateServiceInstanceDefault) WithStatusCode(code int) *CreateServiceInstanceDefault
- func (o *CreateServiceInstanceDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type CreateServiceInstanceHandler
- type CreateServiceInstanceHandlerFunc
- type CreateServiceInstanceOK
- type CreateServiceInstanceParams
- type CreateServiceInstanceUnprocessableEntity
- func (o *CreateServiceInstanceUnprocessableEntity) SetPayload(payload *brokermodel.AsyncError)
- func (o *CreateServiceInstanceUnprocessableEntity) WithPayload(payload *brokermodel.AsyncError) *CreateServiceInstanceUnprocessableEntity
- func (o *CreateServiceInstanceUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type DeprovisionServiceInstance
- type DeprovisionServiceInstanceAccepted
- func (o *DeprovisionServiceInstanceAccepted) SetPayload(payload brokermodel.Empty)
- func (o *DeprovisionServiceInstanceAccepted) WithPayload(payload brokermodel.Empty) *DeprovisionServiceInstanceAccepted
- func (o *DeprovisionServiceInstanceAccepted) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type DeprovisionServiceInstanceDefault
- func (o *DeprovisionServiceInstanceDefault) SetPayload(payload *brokermodel.BrokerError)
- func (o *DeprovisionServiceInstanceDefault) SetStatusCode(code int)
- func (o *DeprovisionServiceInstanceDefault) WithPayload(payload *brokermodel.BrokerError) *DeprovisionServiceInstanceDefault
- func (o *DeprovisionServiceInstanceDefault) WithStatusCode(code int) *DeprovisionServiceInstanceDefault
- func (o *DeprovisionServiceInstanceDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type DeprovisionServiceInstanceGone
- type DeprovisionServiceInstanceHandler
- type DeprovisionServiceInstanceHandlerFunc
- type DeprovisionServiceInstanceOK
- type DeprovisionServiceInstanceParams
- type DeprovisionServiceInstanceUnprocessableEntity
- func (o *DeprovisionServiceInstanceUnprocessableEntity) SetPayload(payload *brokermodel.AsyncError)
- func (o *DeprovisionServiceInstanceUnprocessableEntity) WithPayload(payload *brokermodel.AsyncError) *DeprovisionServiceInstanceUnprocessableEntity
- func (o *DeprovisionServiceInstanceUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type GetServiceInstancesInstanceIDLastOperation
- type GetServiceInstancesInstanceIDLastOperationDefault
- func (o *GetServiceInstancesInstanceIDLastOperationDefault) SetPayload(payload *brokermodel.BrokerError)
- func (o *GetServiceInstancesInstanceIDLastOperationDefault) SetStatusCode(code int)
- func (o *GetServiceInstancesInstanceIDLastOperationDefault) WithPayload(payload *brokermodel.BrokerError) *GetServiceInstancesInstanceIDLastOperationDefault
- func (o *GetServiceInstancesInstanceIDLastOperationDefault) WithStatusCode(code int) *GetServiceInstancesInstanceIDLastOperationDefault
- func (o *GetServiceInstancesInstanceIDLastOperationDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type GetServiceInstancesInstanceIDLastOperationGone
- func (o *GetServiceInstancesInstanceIDLastOperationGone) SetPayload(payload brokermodel.Empty)
- func (o *GetServiceInstancesInstanceIDLastOperationGone) WithPayload(payload brokermodel.Empty) *GetServiceInstancesInstanceIDLastOperationGone
- func (o *GetServiceInstancesInstanceIDLastOperationGone) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type GetServiceInstancesInstanceIDLastOperationHandler
- type GetServiceInstancesInstanceIDLastOperationHandlerFunc
- type GetServiceInstancesInstanceIDLastOperationOK
- func (o *GetServiceInstancesInstanceIDLastOperationOK) SetPayload(payload *brokermodel.LastOperation)
- func (o *GetServiceInstancesInstanceIDLastOperationOK) WithPayload(payload *brokermodel.LastOperation) *GetServiceInstancesInstanceIDLastOperationOK
- func (o *GetServiceInstancesInstanceIDLastOperationOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type GetServiceInstancesInstanceIDLastOperationParams
- type ServiceBind
- type ServiceBindConflict
- type ServiceBindCreated
- type ServiceBindDefault
- func (o *ServiceBindDefault) SetPayload(payload *brokermodel.BrokerError)
- func (o *ServiceBindDefault) SetStatusCode(code int)
- func (o *ServiceBindDefault) WithPayload(payload *brokermodel.BrokerError) *ServiceBindDefault
- func (o *ServiceBindDefault) WithStatusCode(code int) *ServiceBindDefault
- func (o *ServiceBindDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type ServiceBindHandler
- type ServiceBindHandlerFunc
- type ServiceBindOK
- type ServiceBindParams
- type ServiceBindUnprocessableEntity
- type ServiceUnbind
- type ServiceUnbindDefault
- func (o *ServiceUnbindDefault) SetPayload(payload *brokermodel.BrokerError)
- func (o *ServiceUnbindDefault) SetStatusCode(code int)
- func (o *ServiceUnbindDefault) WithPayload(payload *brokermodel.BrokerError) *ServiceUnbindDefault
- func (o *ServiceUnbindDefault) WithStatusCode(code int) *ServiceUnbindDefault
- func (o *ServiceUnbindDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type ServiceUnbindGone
- type ServiceUnbindHandler
- type ServiceUnbindHandlerFunc
- type ServiceUnbindOK
- type ServiceUnbindParams
- type UpdateServiceInstance
- type UpdateServiceInstanceAccepted
- type UpdateServiceInstanceDefault
- func (o *UpdateServiceInstanceDefault) SetPayload(payload *brokermodel.BrokerError)
- func (o *UpdateServiceInstanceDefault) SetStatusCode(code int)
- func (o *UpdateServiceInstanceDefault) WithPayload(payload *brokermodel.BrokerError) *UpdateServiceInstanceDefault
- func (o *UpdateServiceInstanceDefault) WithStatusCode(code int) *UpdateServiceInstanceDefault
- func (o *UpdateServiceInstanceDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateServiceInstanceHandler
- type UpdateServiceInstanceHandlerFunc
- type UpdateServiceInstanceOK
- type UpdateServiceInstanceParams
- type UpdateServiceInstanceUnprocessableEntity
- func (o *UpdateServiceInstanceUnprocessableEntity) SetPayload(payload *brokermodel.AsyncError)
- func (o *UpdateServiceInstanceUnprocessableEntity) WithPayload(payload *brokermodel.AsyncError) *UpdateServiceInstanceUnprocessableEntity
- func (o *UpdateServiceInstanceUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BrokerAPI ¶
type BrokerAPI struct { // JSONConsumer registers a consumer for a "application/json" mime type JSONConsumer runtime.Consumer // JSONProducer registers a producer for a "application/json" mime type JSONProducer runtime.Producer // BasicAuth registers a function that takes username and password and returns a principal // it performs authentication with basic auth BasicAuth func(string, string) (interface{}, error) // GetServiceInstancesInstanceIDLastOperationHandler sets the operation handler for the get service instances instance ID last operation operation GetServiceInstancesInstanceIDLastOperationHandler GetServiceInstancesInstanceIDLastOperationHandler // CatalogCatalogHandler sets the operation handler for the catalog operation CatalogCatalogHandler catalog.CatalogHandler // CreateServiceInstanceHandler sets the operation handler for the create service instance operation CreateServiceInstanceHandler CreateServiceInstanceHandler // DeprovisionServiceInstanceHandler sets the operation handler for the deprovision service instance operation DeprovisionServiceInstanceHandler DeprovisionServiceInstanceHandler // ServiceBindHandler sets the operation handler for the service bind operation ServiceBindHandler ServiceBindHandler // ServiceUnbindHandler sets the operation handler for the service unbind operation ServiceUnbindHandler ServiceUnbindHandler // UpdateServiceInstanceHandler sets the operation handler for the update service instance operation UpdateServiceInstanceHandler UpdateServiceInstanceHandler // ServeError is called when an error is received, there is a default handler // but you can set your own with this ServeError func(http.ResponseWriter, *http.Request, error) // ServerShutdown is called when the HTTP(S) server is shut down and done // handling all active connections and does not accept connections any more ServerShutdown func() // Custom command line argument groups with their descriptions CommandLineOptionsGroups []swag.CommandLineOptionsGroup // User defined logger function. Logger func(string, ...interface{}) // contains filtered or unexported fields }
BrokerAPI The Cloud Foundry services API defines the contract between the Cloud Controller and the service broker. The broker is expected to implement several HTTP (or HTTPS) endpoints underneath a URI prefix. One or more services can be provided by a single broker, and load balancing enables horizontal scalability of redundant brokers. Multiple Cloud Foundry instances can be supported by a single broker using different URL prefixes and credentials. [Learn more about the Service Broker API.](http://docs.cloudfoundry.org/services/api.html)
func NewBrokerAPI ¶
NewBrokerAPI creates a new Broker instance
func (*BrokerAPI) AuthenticatorsFor ¶
func (o *BrokerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*BrokerAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types
func (*BrokerAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*BrokerAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*BrokerAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*BrokerAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types
func (*BrokerAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*BrokerAPI) Serve ¶
func (o *BrokerAPI) Serve(builder middleware.Builder) http.Handler
Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))
func (*BrokerAPI) ServeErrorFor ¶
func (o *BrokerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*BrokerAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*BrokerAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type
type CreateServiceInstance ¶
type CreateServiceInstance struct { Context *middleware.Context Handler CreateServiceInstanceHandler }
CreateServiceInstance swagger:route PUT /service_instances/{instance_id} createServiceInstance
Provisions a service instance ¶
When the broker receives a provision request from Cloud Controller, it should synchronously take whatever action is necessary to create a new service resource for the developer. The result of provisioning varies by service type, although there are a few common actions that work for many services.
func NewCreateServiceInstance ¶
func NewCreateServiceInstance(ctx *middleware.Context, handler CreateServiceInstanceHandler) *CreateServiceInstance
NewCreateServiceInstance creates a new http.Handler for the create service instance operation
func (*CreateServiceInstance) ServeHTTP ¶
func (o *CreateServiceInstance) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type CreateServiceInstanceAccepted ¶
type CreateServiceInstanceAccepted struct { // In: body Payload *brokermodel.DashboardURL `json:"body,omitempty"` }
CreateServiceInstanceAccepted Service instance creation has been accepted
swagger:response createServiceInstanceAccepted
func NewCreateServiceInstanceAccepted ¶
func NewCreateServiceInstanceAccepted() *CreateServiceInstanceAccepted
NewCreateServiceInstanceAccepted creates CreateServiceInstanceAccepted with default headers values
func (*CreateServiceInstanceAccepted) SetPayload ¶
func (o *CreateServiceInstanceAccepted) SetPayload(payload *brokermodel.DashboardURL)
SetPayload sets the payload to the create service instance accepted response
func (*CreateServiceInstanceAccepted) WithPayload ¶
func (o *CreateServiceInstanceAccepted) WithPayload(payload *brokermodel.DashboardURL) *CreateServiceInstanceAccepted
WithPayload adds the payload to the create service instance accepted response
func (*CreateServiceInstanceAccepted) WriteResponse ¶
func (o *CreateServiceInstanceAccepted) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceInstanceConflict ¶
type CreateServiceInstanceConflict struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
CreateServiceInstanceConflict Should be returned if the requested service instance already exists. The expected response body is {}
swagger:response createServiceInstanceConflict
func NewCreateServiceInstanceConflict ¶
func NewCreateServiceInstanceConflict() *CreateServiceInstanceConflict
NewCreateServiceInstanceConflict creates CreateServiceInstanceConflict with default headers values
func (*CreateServiceInstanceConflict) SetPayload ¶
func (o *CreateServiceInstanceConflict) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the create service instance conflict response
func (*CreateServiceInstanceConflict) WithPayload ¶
func (o *CreateServiceInstanceConflict) WithPayload(payload brokermodel.Empty) *CreateServiceInstanceConflict
WithPayload adds the payload to the create service instance conflict response
func (*CreateServiceInstanceConflict) WriteResponse ¶
func (o *CreateServiceInstanceConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceInstanceCreated ¶
type CreateServiceInstanceCreated struct { // In: body Payload *brokermodel.DashboardURL `json:"body,omitempty"` }
CreateServiceInstanceCreated Service instance has been created.
swagger:response createServiceInstanceCreated
func NewCreateServiceInstanceCreated ¶
func NewCreateServiceInstanceCreated() *CreateServiceInstanceCreated
NewCreateServiceInstanceCreated creates CreateServiceInstanceCreated with default headers values
func (*CreateServiceInstanceCreated) SetPayload ¶
func (o *CreateServiceInstanceCreated) SetPayload(payload *brokermodel.DashboardURL)
SetPayload sets the payload to the create service instance created response
func (*CreateServiceInstanceCreated) WithPayload ¶
func (o *CreateServiceInstanceCreated) WithPayload(payload *brokermodel.DashboardURL) *CreateServiceInstanceCreated
WithPayload adds the payload to the create service instance created response
func (*CreateServiceInstanceCreated) WriteResponse ¶
func (o *CreateServiceInstanceCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceInstanceDefault ¶
type CreateServiceInstanceDefault struct { // In: body Payload *brokermodel.BrokerError `json:"body,omitempty"` // contains filtered or unexported fields }
CreateServiceInstanceDefault generic error response
swagger:response createServiceInstanceDefault
func NewCreateServiceInstanceDefault ¶
func NewCreateServiceInstanceDefault(code int) *CreateServiceInstanceDefault
NewCreateServiceInstanceDefault creates CreateServiceInstanceDefault with default headers values
func (*CreateServiceInstanceDefault) SetPayload ¶
func (o *CreateServiceInstanceDefault) SetPayload(payload *brokermodel.BrokerError)
SetPayload sets the payload to the create service instance default response
func (*CreateServiceInstanceDefault) SetStatusCode ¶
func (o *CreateServiceInstanceDefault) SetStatusCode(code int)
SetStatusCode sets the status to the create service instance default response
func (*CreateServiceInstanceDefault) WithPayload ¶
func (o *CreateServiceInstanceDefault) WithPayload(payload *brokermodel.BrokerError) *CreateServiceInstanceDefault
WithPayload adds the payload to the create service instance default response
func (*CreateServiceInstanceDefault) WithStatusCode ¶
func (o *CreateServiceInstanceDefault) WithStatusCode(code int) *CreateServiceInstanceDefault
WithStatusCode adds the status to the create service instance default response
func (*CreateServiceInstanceDefault) WriteResponse ¶
func (o *CreateServiceInstanceDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceInstanceHandler ¶
type CreateServiceInstanceHandler interface {
Handle(CreateServiceInstanceParams, interface{}) middleware.Responder
}
CreateServiceInstanceHandler interface for that can handle valid create service instance params
type CreateServiceInstanceHandlerFunc ¶
type CreateServiceInstanceHandlerFunc func(CreateServiceInstanceParams, interface{}) middleware.Responder
CreateServiceInstanceHandlerFunc turns a function with the right signature into a create service instance handler
func (CreateServiceInstanceHandlerFunc) Handle ¶
func (fn CreateServiceInstanceHandlerFunc) Handle(params CreateServiceInstanceParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type CreateServiceInstanceOK ¶
type CreateServiceInstanceOK struct { // In: body Payload *brokermodel.DashboardURL `json:"body,omitempty"` }
CreateServiceInstanceOK May be returned if the service instance already exists and the requested parameters are identical to the existing service instance. The expected response body is below.
swagger:response createServiceInstanceOK
func NewCreateServiceInstanceOK ¶
func NewCreateServiceInstanceOK() *CreateServiceInstanceOK
NewCreateServiceInstanceOK creates CreateServiceInstanceOK with default headers values
func (*CreateServiceInstanceOK) SetPayload ¶
func (o *CreateServiceInstanceOK) SetPayload(payload *brokermodel.DashboardURL)
SetPayload sets the payload to the create service instance o k response
func (*CreateServiceInstanceOK) WithPayload ¶
func (o *CreateServiceInstanceOK) WithPayload(payload *brokermodel.DashboardURL) *CreateServiceInstanceOK
WithPayload adds the payload to the create service instance o k response
func (*CreateServiceInstanceOK) WriteResponse ¶
func (o *CreateServiceInstanceOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type CreateServiceInstanceParams ¶
type CreateServiceInstanceParams struct { // HTTP Request Object HTTPRequest *http.Request /*The instance_id of a service instance is provided by the Cloud Controller. This ID will be used for future requests (bind and deprovision), so the broker must use it to correlate the resource it creates. Required: true In: path */ InstanceID string /*Service information. Required: true In: body */ Service *brokermodel.Service }
CreateServiceInstanceParams contains all the bound params for the create service instance operation typically these are obtained from a http.Request
swagger:parameters createServiceInstance
func NewCreateServiceInstanceParams ¶
func NewCreateServiceInstanceParams() CreateServiceInstanceParams
NewCreateServiceInstanceParams creates a new CreateServiceInstanceParams object with the default values initialized.
func (*CreateServiceInstanceParams) BindRequest ¶
func (o *CreateServiceInstanceParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type CreateServiceInstanceUnprocessableEntity ¶
type CreateServiceInstanceUnprocessableEntity struct { // In: body Payload *brokermodel.AsyncError `json:"body,omitempty"` }
CreateServiceInstanceUnprocessableEntity Shoud be returned if the broker only supports asynchronous provisioning for the requested plan and the request did not include ?accepts_incomplete=true
swagger:response createServiceInstanceUnprocessableEntity
func NewCreateServiceInstanceUnprocessableEntity ¶
func NewCreateServiceInstanceUnprocessableEntity() *CreateServiceInstanceUnprocessableEntity
NewCreateServiceInstanceUnprocessableEntity creates CreateServiceInstanceUnprocessableEntity with default headers values
func (*CreateServiceInstanceUnprocessableEntity) SetPayload ¶
func (o *CreateServiceInstanceUnprocessableEntity) SetPayload(payload *brokermodel.AsyncError)
SetPayload sets the payload to the create service instance unprocessable entity response
func (*CreateServiceInstanceUnprocessableEntity) WithPayload ¶
func (o *CreateServiceInstanceUnprocessableEntity) WithPayload(payload *brokermodel.AsyncError) *CreateServiceInstanceUnprocessableEntity
WithPayload adds the payload to the create service instance unprocessable entity response
func (*CreateServiceInstanceUnprocessableEntity) WriteResponse ¶
func (o *CreateServiceInstanceUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type DeprovisionServiceInstance ¶
type DeprovisionServiceInstance struct { Context *middleware.Context Handler DeprovisionServiceInstanceHandler }
DeprovisionServiceInstance swagger:route DELETE /service_instances/{instance_id} deprovisionServiceInstance
Deprovisions a service instance.
When a broker receives a deprovision request from Cloud Controller, it should delete any resources it created during the provision. Usually this means that all resources are immediately reclaimed for future provisions.
func NewDeprovisionServiceInstance ¶
func NewDeprovisionServiceInstance(ctx *middleware.Context, handler DeprovisionServiceInstanceHandler) *DeprovisionServiceInstance
NewDeprovisionServiceInstance creates a new http.Handler for the deprovision service instance operation
func (*DeprovisionServiceInstance) ServeHTTP ¶
func (o *DeprovisionServiceInstance) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type DeprovisionServiceInstanceAccepted ¶
type DeprovisionServiceInstanceAccepted struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
DeprovisionServiceInstanceAccepted Service instance update is in progress. This triggers Cloud Controller to poll the Service Instance Last Operation Endpoint for operation status.
swagger:response deprovisionServiceInstanceAccepted
func NewDeprovisionServiceInstanceAccepted ¶
func NewDeprovisionServiceInstanceAccepted() *DeprovisionServiceInstanceAccepted
NewDeprovisionServiceInstanceAccepted creates DeprovisionServiceInstanceAccepted with default headers values
func (*DeprovisionServiceInstanceAccepted) SetPayload ¶
func (o *DeprovisionServiceInstanceAccepted) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the deprovision service instance accepted response
func (*DeprovisionServiceInstanceAccepted) WithPayload ¶
func (o *DeprovisionServiceInstanceAccepted) WithPayload(payload brokermodel.Empty) *DeprovisionServiceInstanceAccepted
WithPayload adds the payload to the deprovision service instance accepted response
func (*DeprovisionServiceInstanceAccepted) WriteResponse ¶
func (o *DeprovisionServiceInstanceAccepted) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type DeprovisionServiceInstanceDefault ¶
type DeprovisionServiceInstanceDefault struct { // In: body Payload *brokermodel.BrokerError `json:"body,omitempty"` // contains filtered or unexported fields }
DeprovisionServiceInstanceDefault generic error response
swagger:response deprovisionServiceInstanceDefault
func NewDeprovisionServiceInstanceDefault ¶
func NewDeprovisionServiceInstanceDefault(code int) *DeprovisionServiceInstanceDefault
NewDeprovisionServiceInstanceDefault creates DeprovisionServiceInstanceDefault with default headers values
func (*DeprovisionServiceInstanceDefault) SetPayload ¶
func (o *DeprovisionServiceInstanceDefault) SetPayload(payload *brokermodel.BrokerError)
SetPayload sets the payload to the deprovision service instance default response
func (*DeprovisionServiceInstanceDefault) SetStatusCode ¶
func (o *DeprovisionServiceInstanceDefault) SetStatusCode(code int)
SetStatusCode sets the status to the deprovision service instance default response
func (*DeprovisionServiceInstanceDefault) WithPayload ¶
func (o *DeprovisionServiceInstanceDefault) WithPayload(payload *brokermodel.BrokerError) *DeprovisionServiceInstanceDefault
WithPayload adds the payload to the deprovision service instance default response
func (*DeprovisionServiceInstanceDefault) WithStatusCode ¶
func (o *DeprovisionServiceInstanceDefault) WithStatusCode(code int) *DeprovisionServiceInstanceDefault
WithStatusCode adds the status to the deprovision service instance default response
func (*DeprovisionServiceInstanceDefault) WriteResponse ¶
func (o *DeprovisionServiceInstanceDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type DeprovisionServiceInstanceGone ¶
type DeprovisionServiceInstanceGone struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
DeprovisionServiceInstanceGone Should be returned if the binding does not exist. The expected response body is {}.
swagger:response deprovisionServiceInstanceGone
func NewDeprovisionServiceInstanceGone ¶
func NewDeprovisionServiceInstanceGone() *DeprovisionServiceInstanceGone
NewDeprovisionServiceInstanceGone creates DeprovisionServiceInstanceGone with default headers values
func (*DeprovisionServiceInstanceGone) SetPayload ¶
func (o *DeprovisionServiceInstanceGone) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the deprovision service instance gone response
func (*DeprovisionServiceInstanceGone) WithPayload ¶
func (o *DeprovisionServiceInstanceGone) WithPayload(payload brokermodel.Empty) *DeprovisionServiceInstanceGone
WithPayload adds the payload to the deprovision service instance gone response
func (*DeprovisionServiceInstanceGone) WriteResponse ¶
func (o *DeprovisionServiceInstanceGone) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type DeprovisionServiceInstanceHandler ¶
type DeprovisionServiceInstanceHandler interface {
Handle(DeprovisionServiceInstanceParams, interface{}) middleware.Responder
}
DeprovisionServiceInstanceHandler interface for that can handle valid deprovision service instance params
type DeprovisionServiceInstanceHandlerFunc ¶
type DeprovisionServiceInstanceHandlerFunc func(DeprovisionServiceInstanceParams, interface{}) middleware.Responder
DeprovisionServiceInstanceHandlerFunc turns a function with the right signature into a deprovision service instance handler
func (DeprovisionServiceInstanceHandlerFunc) Handle ¶
func (fn DeprovisionServiceInstanceHandlerFunc) Handle(params DeprovisionServiceInstanceParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type DeprovisionServiceInstanceOK ¶
type DeprovisionServiceInstanceOK struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
DeprovisionServiceInstanceOK Service instance was deleted. The expected response body is {}.
swagger:response deprovisionServiceInstanceOK
func NewDeprovisionServiceInstanceOK ¶
func NewDeprovisionServiceInstanceOK() *DeprovisionServiceInstanceOK
NewDeprovisionServiceInstanceOK creates DeprovisionServiceInstanceOK with default headers values
func (*DeprovisionServiceInstanceOK) SetPayload ¶
func (o *DeprovisionServiceInstanceOK) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the deprovision service instance o k response
func (*DeprovisionServiceInstanceOK) WithPayload ¶
func (o *DeprovisionServiceInstanceOK) WithPayload(payload brokermodel.Empty) *DeprovisionServiceInstanceOK
WithPayload adds the payload to the deprovision service instance o k response
func (*DeprovisionServiceInstanceOK) WriteResponse ¶
func (o *DeprovisionServiceInstanceOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type DeprovisionServiceInstanceParams ¶
type DeprovisionServiceInstanceParams struct { // HTTP Request Object HTTPRequest *http.Request /*The instance_id of a service instance is provided by the Cloud Controller. This ID will be used for future requests (bind and deprovision), so the broker must use it to correlate the resource it creates. Required: true In: path */ InstanceID string /*the plan id as stored in the catalog Required: true In: query */ PlanID string /*the service id as stored in the catalog Required: true In: query */ ServiceID string }
DeprovisionServiceInstanceParams contains all the bound params for the deprovision service instance operation typically these are obtained from a http.Request
swagger:parameters deprovisionServiceInstance
func NewDeprovisionServiceInstanceParams ¶
func NewDeprovisionServiceInstanceParams() DeprovisionServiceInstanceParams
NewDeprovisionServiceInstanceParams creates a new DeprovisionServiceInstanceParams object with the default values initialized.
func (*DeprovisionServiceInstanceParams) BindRequest ¶
func (o *DeprovisionServiceInstanceParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type DeprovisionServiceInstanceUnprocessableEntity ¶
type DeprovisionServiceInstanceUnprocessableEntity struct { // In: body Payload *brokermodel.AsyncError `json:"body,omitempty"` }
DeprovisionServiceInstanceUnprocessableEntity Should be returned if the broker only supports asynchronous deprovisioning for the requested plan and the request did not include ?accepts_incomplete=true
swagger:response deprovisionServiceInstanceUnprocessableEntity
func NewDeprovisionServiceInstanceUnprocessableEntity ¶
func NewDeprovisionServiceInstanceUnprocessableEntity() *DeprovisionServiceInstanceUnprocessableEntity
NewDeprovisionServiceInstanceUnprocessableEntity creates DeprovisionServiceInstanceUnprocessableEntity with default headers values
func (*DeprovisionServiceInstanceUnprocessableEntity) SetPayload ¶
func (o *DeprovisionServiceInstanceUnprocessableEntity) SetPayload(payload *brokermodel.AsyncError)
SetPayload sets the payload to the deprovision service instance unprocessable entity response
func (*DeprovisionServiceInstanceUnprocessableEntity) WithPayload ¶
func (o *DeprovisionServiceInstanceUnprocessableEntity) WithPayload(payload *brokermodel.AsyncError) *DeprovisionServiceInstanceUnprocessableEntity
WithPayload adds the payload to the deprovision service instance unprocessable entity response
func (*DeprovisionServiceInstanceUnprocessableEntity) WriteResponse ¶
func (o *DeprovisionServiceInstanceUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetServiceInstancesInstanceIDLastOperation ¶
type GetServiceInstancesInstanceIDLastOperation struct { Context *middleware.Context Handler GetServiceInstancesInstanceIDLastOperationHandler }
GetServiceInstancesInstanceIDLastOperation swagger:route GET /service_instances/{instance_id}/last_operation getServiceInstancesInstanceIdLastOperation
Polling Last Operation (async only)
When a broker returns status code 202 ACCEPTED for provision, update, or deprovision, Cloud Foundry will begin to poll the /v2/service_instances/:guid/last_operation endpoint to obtain the state of the last requested operation. The broker response must contain the field state and an optional field description.
func NewGetServiceInstancesInstanceIDLastOperation ¶
func NewGetServiceInstancesInstanceIDLastOperation(ctx *middleware.Context, handler GetServiceInstancesInstanceIDLastOperationHandler) *GetServiceInstancesInstanceIDLastOperation
NewGetServiceInstancesInstanceIDLastOperation creates a new http.Handler for the get service instances instance ID last operation operation
func (*GetServiceInstancesInstanceIDLastOperation) ServeHTTP ¶
func (o *GetServiceInstancesInstanceIDLastOperation) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type GetServiceInstancesInstanceIDLastOperationDefault ¶
type GetServiceInstancesInstanceIDLastOperationDefault struct { // In: body Payload *brokermodel.BrokerError `json:"body,omitempty"` // contains filtered or unexported fields }
GetServiceInstancesInstanceIDLastOperationDefault generic error response
swagger:response getServiceInstancesInstanceIdLastOperationDefault
func NewGetServiceInstancesInstanceIDLastOperationDefault ¶
func NewGetServiceInstancesInstanceIDLastOperationDefault(code int) *GetServiceInstancesInstanceIDLastOperationDefault
NewGetServiceInstancesInstanceIDLastOperationDefault creates GetServiceInstancesInstanceIDLastOperationDefault with default headers values
func (*GetServiceInstancesInstanceIDLastOperationDefault) SetPayload ¶
func (o *GetServiceInstancesInstanceIDLastOperationDefault) SetPayload(payload *brokermodel.BrokerError)
SetPayload sets the payload to the get service instances instance ID last operation default response
func (*GetServiceInstancesInstanceIDLastOperationDefault) SetStatusCode ¶
func (o *GetServiceInstancesInstanceIDLastOperationDefault) SetStatusCode(code int)
SetStatusCode sets the status to the get service instances instance ID last operation default response
func (*GetServiceInstancesInstanceIDLastOperationDefault) WithPayload ¶
func (o *GetServiceInstancesInstanceIDLastOperationDefault) WithPayload(payload *brokermodel.BrokerError) *GetServiceInstancesInstanceIDLastOperationDefault
WithPayload adds the payload to the get service instances instance ID last operation default response
func (*GetServiceInstancesInstanceIDLastOperationDefault) WithStatusCode ¶
func (o *GetServiceInstancesInstanceIDLastOperationDefault) WithStatusCode(code int) *GetServiceInstancesInstanceIDLastOperationDefault
WithStatusCode adds the status to the get service instances instance ID last operation default response
func (*GetServiceInstancesInstanceIDLastOperationDefault) WriteResponse ¶
func (o *GetServiceInstancesInstanceIDLastOperationDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetServiceInstancesInstanceIDLastOperationGone ¶
type GetServiceInstancesInstanceIDLastOperationGone struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
GetServiceInstancesInstanceIDLastOperationGone Appropriate only for asynchronous delete requests. Cloud Foundry will consider this response a success and remove the resource from its database.
swagger:response getServiceInstancesInstanceIdLastOperationGone
func NewGetServiceInstancesInstanceIDLastOperationGone ¶
func NewGetServiceInstancesInstanceIDLastOperationGone() *GetServiceInstancesInstanceIDLastOperationGone
NewGetServiceInstancesInstanceIDLastOperationGone creates GetServiceInstancesInstanceIDLastOperationGone with default headers values
func (*GetServiceInstancesInstanceIDLastOperationGone) SetPayload ¶
func (o *GetServiceInstancesInstanceIDLastOperationGone) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the get service instances instance Id last operation gone response
func (*GetServiceInstancesInstanceIDLastOperationGone) WithPayload ¶
func (o *GetServiceInstancesInstanceIDLastOperationGone) WithPayload(payload brokermodel.Empty) *GetServiceInstancesInstanceIDLastOperationGone
WithPayload adds the payload to the get service instances instance Id last operation gone response
func (*GetServiceInstancesInstanceIDLastOperationGone) WriteResponse ¶
func (o *GetServiceInstancesInstanceIDLastOperationGone) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetServiceInstancesInstanceIDLastOperationHandler ¶
type GetServiceInstancesInstanceIDLastOperationHandler interface {
Handle(GetServiceInstancesInstanceIDLastOperationParams, interface{}) middleware.Responder
}
GetServiceInstancesInstanceIDLastOperationHandler interface for that can handle valid get service instances instance ID last operation params
type GetServiceInstancesInstanceIDLastOperationHandlerFunc ¶
type GetServiceInstancesInstanceIDLastOperationHandlerFunc func(GetServiceInstancesInstanceIDLastOperationParams, interface{}) middleware.Responder
GetServiceInstancesInstanceIDLastOperationHandlerFunc turns a function with the right signature into a get service instances instance ID last operation handler
func (GetServiceInstancesInstanceIDLastOperationHandlerFunc) Handle ¶
func (fn GetServiceInstancesInstanceIDLastOperationHandlerFunc) Handle(params GetServiceInstancesInstanceIDLastOperationParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type GetServiceInstancesInstanceIDLastOperationOK ¶
type GetServiceInstancesInstanceIDLastOperationOK struct { // In: body Payload *brokermodel.LastOperation `json:"body,omitempty"` }
GetServiceInstancesInstanceIDLastOperationOK Valid state values are 'in progress', 'succeeded', and 'failed'
swagger:response getServiceInstancesInstanceIdLastOperationOK
func NewGetServiceInstancesInstanceIDLastOperationOK ¶
func NewGetServiceInstancesInstanceIDLastOperationOK() *GetServiceInstancesInstanceIDLastOperationOK
NewGetServiceInstancesInstanceIDLastOperationOK creates GetServiceInstancesInstanceIDLastOperationOK with default headers values
func (*GetServiceInstancesInstanceIDLastOperationOK) SetPayload ¶
func (o *GetServiceInstancesInstanceIDLastOperationOK) SetPayload(payload *brokermodel.LastOperation)
SetPayload sets the payload to the get service instances instance Id last operation o k response
func (*GetServiceInstancesInstanceIDLastOperationOK) WithPayload ¶
func (o *GetServiceInstancesInstanceIDLastOperationOK) WithPayload(payload *brokermodel.LastOperation) *GetServiceInstancesInstanceIDLastOperationOK
WithPayload adds the payload to the get service instances instance Id last operation o k response
func (*GetServiceInstancesInstanceIDLastOperationOK) WriteResponse ¶
func (o *GetServiceInstancesInstanceIDLastOperationOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetServiceInstancesInstanceIDLastOperationParams ¶
type GetServiceInstancesInstanceIDLastOperationParams struct { // HTTP Request Object HTTPRequest *http.Request /*The instance_id of a service instance is provided by the Cloud Controller. This ID will be used for future requests (bind and deprovision), so the broker must use it to correlate the resource it creates. Required: true In: path */ InstanceID string }
GetServiceInstancesInstanceIDLastOperationParams contains all the bound params for the get service instances instance ID last operation operation typically these are obtained from a http.Request
swagger:parameters GetServiceInstancesInstanceIDLastOperation
func NewGetServiceInstancesInstanceIDLastOperationParams ¶
func NewGetServiceInstancesInstanceIDLastOperationParams() GetServiceInstancesInstanceIDLastOperationParams
NewGetServiceInstancesInstanceIDLastOperationParams creates a new GetServiceInstancesInstanceIDLastOperationParams object with the default values initialized.
func (*GetServiceInstancesInstanceIDLastOperationParams) BindRequest ¶
func (o *GetServiceInstancesInstanceIDLastOperationParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type ServiceBind ¶
type ServiceBind struct { Context *middleware.Context Handler ServiceBindHandler }
ServiceBind swagger:route PUT /service_instances/{instance_id}/service_bindings/{binding_id} serviceBind
Binds to a service ¶
When the broker receives a bind request from the Cloud Controller, it should return information which helps an application to utilize the provisioned resource. This information is generically referred to as credentials. Applications should be issued unique credentials whenever possible, so one application access can be revoked without affecting other bound applications. For more information on credentials, [see Binding Credentials](https://docs.cloudfoundry.org/services/binding-credentials.html).
func NewServiceBind ¶
func NewServiceBind(ctx *middleware.Context, handler ServiceBindHandler) *ServiceBind
NewServiceBind creates a new http.Handler for the service bind operation
func (*ServiceBind) ServeHTTP ¶
func (o *ServiceBind) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type ServiceBindConflict ¶
type ServiceBindConflict struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
ServiceBindConflict Should be returned if the requested binding already exists. The expected response body is {}, though the description field can be used to return a user-facing error message, as described in Broker Errors.
swagger:response serviceBindConflict
func NewServiceBindConflict ¶
func NewServiceBindConflict() *ServiceBindConflict
NewServiceBindConflict creates ServiceBindConflict with default headers values
func (*ServiceBindConflict) SetPayload ¶
func (o *ServiceBindConflict) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the service bind conflict response
func (*ServiceBindConflict) WithPayload ¶
func (o *ServiceBindConflict) WithPayload(payload brokermodel.Empty) *ServiceBindConflict
WithPayload adds the payload to the service bind conflict response
func (*ServiceBindConflict) WriteResponse ¶
func (o *ServiceBindConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceBindCreated ¶
type ServiceBindCreated struct { // In: body Payload *brokermodel.BindingResponse `json:"body,omitempty"` }
ServiceBindCreated Binding has been created.
swagger:response serviceBindCreated
func NewServiceBindCreated ¶
func NewServiceBindCreated() *ServiceBindCreated
NewServiceBindCreated creates ServiceBindCreated with default headers values
func (*ServiceBindCreated) SetPayload ¶
func (o *ServiceBindCreated) SetPayload(payload *brokermodel.BindingResponse)
SetPayload sets the payload to the service bind created response
func (*ServiceBindCreated) WithPayload ¶
func (o *ServiceBindCreated) WithPayload(payload *brokermodel.BindingResponse) *ServiceBindCreated
WithPayload adds the payload to the service bind created response
func (*ServiceBindCreated) WriteResponse ¶
func (o *ServiceBindCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceBindDefault ¶
type ServiceBindDefault struct { // In: body Payload *brokermodel.BrokerError `json:"body,omitempty"` // contains filtered or unexported fields }
ServiceBindDefault generic error response
swagger:response serviceBindDefault
func NewServiceBindDefault ¶
func NewServiceBindDefault(code int) *ServiceBindDefault
NewServiceBindDefault creates ServiceBindDefault with default headers values
func (*ServiceBindDefault) SetPayload ¶
func (o *ServiceBindDefault) SetPayload(payload *brokermodel.BrokerError)
SetPayload sets the payload to the service bind default response
func (*ServiceBindDefault) SetStatusCode ¶
func (o *ServiceBindDefault) SetStatusCode(code int)
SetStatusCode sets the status to the service bind default response
func (*ServiceBindDefault) WithPayload ¶
func (o *ServiceBindDefault) WithPayload(payload *brokermodel.BrokerError) *ServiceBindDefault
WithPayload adds the payload to the service bind default response
func (*ServiceBindDefault) WithStatusCode ¶
func (o *ServiceBindDefault) WithStatusCode(code int) *ServiceBindDefault
WithStatusCode adds the status to the service bind default response
func (*ServiceBindDefault) WriteResponse ¶
func (o *ServiceBindDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceBindHandler ¶
type ServiceBindHandler interface {
Handle(ServiceBindParams, interface{}) middleware.Responder
}
ServiceBindHandler interface for that can handle valid service bind params
type ServiceBindHandlerFunc ¶
type ServiceBindHandlerFunc func(ServiceBindParams, interface{}) middleware.Responder
ServiceBindHandlerFunc turns a function with the right signature into a service bind handler
func (ServiceBindHandlerFunc) Handle ¶
func (fn ServiceBindHandlerFunc) Handle(params ServiceBindParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type ServiceBindOK ¶
type ServiceBindOK struct { // In: body Payload *brokermodel.BindingResponse `json:"body,omitempty"` }
ServiceBindOK May be returned if the binding already exists and the requested parameters are identical to the existing binding.
swagger:response serviceBindOK
func NewServiceBindOK ¶
func NewServiceBindOK() *ServiceBindOK
NewServiceBindOK creates ServiceBindOK with default headers values
func (*ServiceBindOK) SetPayload ¶
func (o *ServiceBindOK) SetPayload(payload *brokermodel.BindingResponse)
SetPayload sets the payload to the service bind o k response
func (*ServiceBindOK) WithPayload ¶
func (o *ServiceBindOK) WithPayload(payload *brokermodel.BindingResponse) *ServiceBindOK
WithPayload adds the payload to the service bind o k response
func (*ServiceBindOK) WriteResponse ¶
func (o *ServiceBindOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceBindParams ¶
type ServiceBindParams struct { // HTTP Request Object HTTPRequest *http.Request /* Required: true In: body */ Binding *brokermodel.Binding /*The binding_id of a service binding is provided by the Cloud Controller. Required: true In: path */ BindingID string /*The instance_id of a service instance is provided by the Cloud Controller. This ID will be used for future requests (bind and deprovision), so the broker must use it to correlate the resource it creates. Required: true In: path */ InstanceID string }
ServiceBindParams contains all the bound params for the service bind operation typically these are obtained from a http.Request
swagger:parameters serviceBind
func NewServiceBindParams ¶
func NewServiceBindParams() ServiceBindParams
NewServiceBindParams creates a new ServiceBindParams object with the default values initialized.
func (*ServiceBindParams) BindRequest ¶
func (o *ServiceBindParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type ServiceBindUnprocessableEntity ¶
type ServiceBindUnprocessableEntity struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
ServiceBindUnprocessableEntity Should be returned if the broker requires that app_guid be included in the request body.
swagger:response serviceBindUnprocessableEntity
func NewServiceBindUnprocessableEntity ¶
func NewServiceBindUnprocessableEntity() *ServiceBindUnprocessableEntity
NewServiceBindUnprocessableEntity creates ServiceBindUnprocessableEntity with default headers values
func (*ServiceBindUnprocessableEntity) SetPayload ¶
func (o *ServiceBindUnprocessableEntity) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the service bind unprocessable entity response
func (*ServiceBindUnprocessableEntity) WithPayload ¶
func (o *ServiceBindUnprocessableEntity) WithPayload(payload brokermodel.Empty) *ServiceBindUnprocessableEntity
WithPayload adds the payload to the service bind unprocessable entity response
func (*ServiceBindUnprocessableEntity) WriteResponse ¶
func (o *ServiceBindUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceUnbind ¶
type ServiceUnbind struct { Context *middleware.Context Handler ServiceUnbindHandler }
ServiceUnbind swagger:route DELETE /service_instances/{instance_id}/service_bindings/{binding_id} serviceUnbind
Unbinds a service ¶
When a broker receives an unbind request from Cloud Controller, it should delete any resources it created in bind. Usually this means that an application immediately cannot access the resource.
func NewServiceUnbind ¶
func NewServiceUnbind(ctx *middleware.Context, handler ServiceUnbindHandler) *ServiceUnbind
NewServiceUnbind creates a new http.Handler for the service unbind operation
func (*ServiceUnbind) ServeHTTP ¶
func (o *ServiceUnbind) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type ServiceUnbindDefault ¶
type ServiceUnbindDefault struct { // In: body Payload *brokermodel.BrokerError `json:"body,omitempty"` // contains filtered or unexported fields }
ServiceUnbindDefault generic error response
swagger:response serviceUnbindDefault
func NewServiceUnbindDefault ¶
func NewServiceUnbindDefault(code int) *ServiceUnbindDefault
NewServiceUnbindDefault creates ServiceUnbindDefault with default headers values
func (*ServiceUnbindDefault) SetPayload ¶
func (o *ServiceUnbindDefault) SetPayload(payload *brokermodel.BrokerError)
SetPayload sets the payload to the service unbind default response
func (*ServiceUnbindDefault) SetStatusCode ¶
func (o *ServiceUnbindDefault) SetStatusCode(code int)
SetStatusCode sets the status to the service unbind default response
func (*ServiceUnbindDefault) WithPayload ¶
func (o *ServiceUnbindDefault) WithPayload(payload *brokermodel.BrokerError) *ServiceUnbindDefault
WithPayload adds the payload to the service unbind default response
func (*ServiceUnbindDefault) WithStatusCode ¶
func (o *ServiceUnbindDefault) WithStatusCode(code int) *ServiceUnbindDefault
WithStatusCode adds the status to the service unbind default response
func (*ServiceUnbindDefault) WriteResponse ¶
func (o *ServiceUnbindDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceUnbindGone ¶
type ServiceUnbindGone struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
ServiceUnbindGone Should be returned if the binding does not exist. The expected response body is {}.
swagger:response serviceUnbindGone
func NewServiceUnbindGone ¶
func NewServiceUnbindGone() *ServiceUnbindGone
NewServiceUnbindGone creates ServiceUnbindGone with default headers values
func (*ServiceUnbindGone) SetPayload ¶
func (o *ServiceUnbindGone) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the service unbind gone response
func (*ServiceUnbindGone) WithPayload ¶
func (o *ServiceUnbindGone) WithPayload(payload brokermodel.Empty) *ServiceUnbindGone
WithPayload adds the payload to the service unbind gone response
func (*ServiceUnbindGone) WriteResponse ¶
func (o *ServiceUnbindGone) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceUnbindHandler ¶
type ServiceUnbindHandler interface {
Handle(ServiceUnbindParams, interface{}) middleware.Responder
}
ServiceUnbindHandler interface for that can handle valid service unbind params
type ServiceUnbindHandlerFunc ¶
type ServiceUnbindHandlerFunc func(ServiceUnbindParams, interface{}) middleware.Responder
ServiceUnbindHandlerFunc turns a function with the right signature into a service unbind handler
func (ServiceUnbindHandlerFunc) Handle ¶
func (fn ServiceUnbindHandlerFunc) Handle(params ServiceUnbindParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type ServiceUnbindOK ¶
type ServiceUnbindOK struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
ServiceUnbindOK Binding was deleted. The expected response body is {}.
swagger:response serviceUnbindOK
func NewServiceUnbindOK ¶
func NewServiceUnbindOK() *ServiceUnbindOK
NewServiceUnbindOK creates ServiceUnbindOK with default headers values
func (*ServiceUnbindOK) SetPayload ¶
func (o *ServiceUnbindOK) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the service unbind o k response
func (*ServiceUnbindOK) WithPayload ¶
func (o *ServiceUnbindOK) WithPayload(payload brokermodel.Empty) *ServiceUnbindOK
WithPayload adds the payload to the service unbind o k response
func (*ServiceUnbindOK) WriteResponse ¶
func (o *ServiceUnbindOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ServiceUnbindParams ¶
type ServiceUnbindParams struct { // HTTP Request Object HTTPRequest *http.Request /*The binding_id of a service binding is provided by the Cloud Controller. Required: true In: path */ BindingID string /*The instance_id of a service instance is provided by the Cloud Controller. This ID will be used for future requests (bind and deprovision), so the broker must use it to correlate the resource it creates. Required: true In: path */ InstanceID string /*the plan id as stored in the catalog Required: true In: query */ PlanID string /*the service id as stored in the catalog Required: true In: query */ ServiceID string }
ServiceUnbindParams contains all the bound params for the service unbind operation typically these are obtained from a http.Request
swagger:parameters serviceUnbind
func NewServiceUnbindParams ¶
func NewServiceUnbindParams() ServiceUnbindParams
NewServiceUnbindParams creates a new ServiceUnbindParams object with the default values initialized.
func (*ServiceUnbindParams) BindRequest ¶
func (o *ServiceUnbindParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type UpdateServiceInstance ¶
type UpdateServiceInstance struct { Context *middleware.Context Handler UpdateServiceInstanceHandler }
UpdateServiceInstance swagger:route PATCH /service_instances/{instance_id} updateServiceInstance
Updating a Service Instance ¶
Brokers that implement this endpoint can enable users to modify attributes of an existing service instance. The first attribute Cloud Foundry supports users modifying is the service plan. This effectively enables users to upgrade or downgrade their service instance to other plans. To see how users make these requests, [see Managing Services](https://docs.cloudfoundry.org/devguide/services/managing-services.html#update_service).
func NewUpdateServiceInstance ¶
func NewUpdateServiceInstance(ctx *middleware.Context, handler UpdateServiceInstanceHandler) *UpdateServiceInstance
NewUpdateServiceInstance creates a new http.Handler for the update service instance operation
func (*UpdateServiceInstance) ServeHTTP ¶
func (o *UpdateServiceInstance) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type UpdateServiceInstanceAccepted ¶
type UpdateServiceInstanceAccepted struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
UpdateServiceInstanceAccepted Service instance update is in progress. This triggers Cloud Controller to poll the Service Instance Last Operation Endpoint for operation status.
swagger:response updateServiceInstanceAccepted
func NewUpdateServiceInstanceAccepted ¶
func NewUpdateServiceInstanceAccepted() *UpdateServiceInstanceAccepted
NewUpdateServiceInstanceAccepted creates UpdateServiceInstanceAccepted with default headers values
func (*UpdateServiceInstanceAccepted) SetPayload ¶
func (o *UpdateServiceInstanceAccepted) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the update service instance accepted response
func (*UpdateServiceInstanceAccepted) WithPayload ¶
func (o *UpdateServiceInstanceAccepted) WithPayload(payload brokermodel.Empty) *UpdateServiceInstanceAccepted
WithPayload adds the payload to the update service instance accepted response
func (*UpdateServiceInstanceAccepted) WriteResponse ¶
func (o *UpdateServiceInstanceAccepted) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateServiceInstanceDefault ¶
type UpdateServiceInstanceDefault struct { // In: body Payload *brokermodel.BrokerError `json:"body,omitempty"` // contains filtered or unexported fields }
UpdateServiceInstanceDefault generic error response
swagger:response updateServiceInstanceDefault
func NewUpdateServiceInstanceDefault ¶
func NewUpdateServiceInstanceDefault(code int) *UpdateServiceInstanceDefault
NewUpdateServiceInstanceDefault creates UpdateServiceInstanceDefault with default headers values
func (*UpdateServiceInstanceDefault) SetPayload ¶
func (o *UpdateServiceInstanceDefault) SetPayload(payload *brokermodel.BrokerError)
SetPayload sets the payload to the update service instance default response
func (*UpdateServiceInstanceDefault) SetStatusCode ¶
func (o *UpdateServiceInstanceDefault) SetStatusCode(code int)
SetStatusCode sets the status to the update service instance default response
func (*UpdateServiceInstanceDefault) WithPayload ¶
func (o *UpdateServiceInstanceDefault) WithPayload(payload *brokermodel.BrokerError) *UpdateServiceInstanceDefault
WithPayload adds the payload to the update service instance default response
func (*UpdateServiceInstanceDefault) WithStatusCode ¶
func (o *UpdateServiceInstanceDefault) WithStatusCode(code int) *UpdateServiceInstanceDefault
WithStatusCode adds the status to the update service instance default response
func (*UpdateServiceInstanceDefault) WriteResponse ¶
func (o *UpdateServiceInstanceDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateServiceInstanceHandler ¶
type UpdateServiceInstanceHandler interface {
Handle(UpdateServiceInstanceParams, interface{}) middleware.Responder
}
UpdateServiceInstanceHandler interface for that can handle valid update service instance params
type UpdateServiceInstanceHandlerFunc ¶
type UpdateServiceInstanceHandlerFunc func(UpdateServiceInstanceParams, interface{}) middleware.Responder
UpdateServiceInstanceHandlerFunc turns a function with the right signature into a update service instance handler
func (UpdateServiceInstanceHandlerFunc) Handle ¶
func (fn UpdateServiceInstanceHandlerFunc) Handle(params UpdateServiceInstanceParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type UpdateServiceInstanceOK ¶
type UpdateServiceInstanceOK struct { // In: body Payload brokermodel.Empty `json:"body,omitempty"` }
UpdateServiceInstanceOK New plan is effective. The expected response body is {}.
swagger:response updateServiceInstanceOK
func NewUpdateServiceInstanceOK ¶
func NewUpdateServiceInstanceOK() *UpdateServiceInstanceOK
NewUpdateServiceInstanceOK creates UpdateServiceInstanceOK with default headers values
func (*UpdateServiceInstanceOK) SetPayload ¶
func (o *UpdateServiceInstanceOK) SetPayload(payload brokermodel.Empty)
SetPayload sets the payload to the update service instance o k response
func (*UpdateServiceInstanceOK) WithPayload ¶
func (o *UpdateServiceInstanceOK) WithPayload(payload brokermodel.Empty) *UpdateServiceInstanceOK
WithPayload adds the payload to the update service instance o k response
func (*UpdateServiceInstanceOK) WriteResponse ¶
func (o *UpdateServiceInstanceOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateServiceInstanceParams ¶
type UpdateServiceInstanceParams struct { // HTTP Request Object HTTPRequest *http.Request /*The instance_id of a service instance is provided by the Cloud Controller. This ID will be used for future requests (bind and deprovision), so the broker must use it to correlate the resource it creates. Required: true In: path */ InstanceID string /*New Plan information. Required: true In: body */ Plan *brokermodel.ServicePlan }
UpdateServiceInstanceParams contains all the bound params for the update service instance operation typically these are obtained from a http.Request
swagger:parameters updateServiceInstance
func NewUpdateServiceInstanceParams ¶
func NewUpdateServiceInstanceParams() UpdateServiceInstanceParams
NewUpdateServiceInstanceParams creates a new UpdateServiceInstanceParams object with the default values initialized.
func (*UpdateServiceInstanceParams) BindRequest ¶
func (o *UpdateServiceInstanceParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls
type UpdateServiceInstanceUnprocessableEntity ¶
type UpdateServiceInstanceUnprocessableEntity struct { // In: body Payload *brokermodel.AsyncError `json:"body,omitempty"` }
UpdateServiceInstanceUnprocessableEntity May be returned if the particular plan change requested is not supported or if the request can not currently be fulfilled due to the state of the instance (eg. instance utilization is over the quota of the requested plan). Broker should include a user-facing message in the body; for details [see Broker Errors](https://docs.cloudfoundry.org/services/api.html#broker-errors).
swagger:response updateServiceInstanceUnprocessableEntity
func NewUpdateServiceInstanceUnprocessableEntity ¶
func NewUpdateServiceInstanceUnprocessableEntity() *UpdateServiceInstanceUnprocessableEntity
NewUpdateServiceInstanceUnprocessableEntity creates UpdateServiceInstanceUnprocessableEntity with default headers values
func (*UpdateServiceInstanceUnprocessableEntity) SetPayload ¶
func (o *UpdateServiceInstanceUnprocessableEntity) SetPayload(payload *brokermodel.AsyncError)
SetPayload sets the payload to the update service instance unprocessable entity response
func (*UpdateServiceInstanceUnprocessableEntity) WithPayload ¶
func (o *UpdateServiceInstanceUnprocessableEntity) WithPayload(payload *brokermodel.AsyncError) *UpdateServiceInstanceUnprocessableEntity
WithPayload adds the payload to the update service instance unprocessable entity response
func (*UpdateServiceInstanceUnprocessableEntity) WriteResponse ¶
func (o *UpdateServiceInstanceUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
Source Files
¶
- broker_api.go
- create_service_instance.go
- create_service_instance_parameters.go
- create_service_instance_responses.go
- deprovision_service_instance.go
- deprovision_service_instance_parameters.go
- deprovision_service_instance_responses.go
- get_service_instances_instance_id_last_operation.go
- get_service_instances_instance_id_last_operation_parameters.go
- get_service_instances_instance_id_last_operation_responses.go
- service_bind.go
- service_bind_parameters.go
- service_bind_responses.go
- service_unbind.go
- service_unbind_parameters.go
- service_unbind_responses.go
- update_service_instance.go
- update_service_instance_parameters.go
- update_service_instance_responses.go