Documentation
¶
Index ¶
- Constants
- Variables
- func ValidateBindRequest(breq *BindRequest) field.ErrorList
- func ValidateProvisionRequest(preq *ProvisionRequest) field.ErrorList
- func ValidateUUID(path *field.Path, uuid string) field.ErrorList
- type BindRequest
- type BindResponse
- type Broker
- type CatalogResponse
- type DashboardClient
- type DeprovisionResponse
- type ErrorResponse
- type KubernetesContext
- type LastOperationResponse
- type LastOperationState
- type Operation
- type Plan
- type ProvisionRequest
- type ProvisionResponse
- type Response
- type Schema
- type Service
- type ServiceBindings
- type ServiceInstances
- type UnbindResponse
- type UpdateRequest
- type UpdateResponse
Constants ¶
View Source
const ( XBrokerAPIVersion = "X-Broker-Api-Version" APIVersion = "2.11" )
View Source
const ( ServiceMetadataDisplayName = "displayName" ServiceMetadataImageURL = "imageUrl" ServiceMetadataLongDescription = "longDescription" ServiceMetadataProviderDisplayName = "providerDisplayName" ServiceMetadataDocumentationURL = "documentationUrl" ServiceMetadataSupportURL = "supportUrl" )
View Source
const ContextPlatformKubernetes = "kubernetes"
Variables ¶
View Source
var AsyncRequired = asyncRequiredResponse{
Error: "AsyncRequired",
Description: "This service plan requires client support for asynchronous service operations.",
}
Functions ¶
func ValidateBindRequest ¶
func ValidateBindRequest(breq *BindRequest) field.ErrorList
func ValidateProvisionRequest ¶
func ValidateProvisionRequest(preq *ProvisionRequest) field.ErrorList
Types ¶
type BindRequest ¶
type BindRequest struct {
ServiceID string `json:"service_id"`
PlanID string `json:"plan_id"`
AppGUID string `json:"app_guid,omitempty"`
BindResource struct {
AppGUID string `json:"app_guid,omitempty"`
Route string `json:"route,omitempty"`
} `json:"bind_resource,omitempty"`
Parameters map[string]string `json:"parameters,omitempty"`
}
type BindResponse ¶
type Broker ¶
type Broker interface {
WaitForReady() error
Catalog() *Response
Provision(instanceID string, preq *ProvisionRequest) *Response
Deprovision(instanceID string) *Response
Bind(instanceID string, bindingID string, breq *BindRequest) *Response
Unbind(instanceID string, bindingID string) *Response
LastOperation(instanceID string, operation Operation) *Response
}
type CatalogResponse ¶
type CatalogResponse struct {
Services []*Service `json:"services"`
}
type DashboardClient ¶
type DeprovisionResponse ¶
type DeprovisionResponse struct {
Operation Operation `json:"operation,omitempty"`
}
type ErrorResponse ¶
type ErrorResponse struct {
Description string `json:"description"`
}
type KubernetesContext ¶
type LastOperationResponse ¶
type LastOperationResponse struct {
State LastOperationState `json:"state"`
Description string `json:"description,omitempty"`
}
type LastOperationState ¶
type LastOperationState string
const ( LastOperationStateInProgress LastOperationState = "in progress" LastOperationStateSucceeded LastOperationState = "succeeded" LastOperationStateFailed LastOperationState = "failed" )
type ProvisionRequest ¶
type ProvisionResponse ¶
type Schema ¶
type Schema struct {
ServiceInstance ServiceInstances `json:"service_instance,omitempty"`
ServiceBinding ServiceBindings `json:"service_binding,omitempty"`
}
type Service ¶
type Service struct {
Name string `json:"name"`
ID string `json:"id"`
Description string `json:"description"`
Tags []string `json:"tags,omitempty"`
Requires []string `json:"requires,omitempty"`
Bindable bool `json:"bindable"`
Metadata map[string]interface{} `json:"metadata,omitempty"`
DashboardClient *DashboardClient `json:"dashboard_client,omitempty"`
PlanUpdatable bool `json:"plan_updateable,omitempty"`
Plans []Plan `json:"plans"`
}
type ServiceBindings ¶
type ServiceInstances ¶
type UnbindResponse ¶
type UnbindResponse struct {
}
type UpdateRequest ¶
type UpdateRequest struct {
Context KubernetesContext `json:"context,omitempty"`
ServiceID string `json:"service_id"`
PlanID string `json:"plan_id,omitempty"`
Parameters map[string]string `json:"parameters,omitempty"`
PreviousValues struct {
ServiceID string `json:"service_id,omitempty"`
PlanID string `json:"plan_id,omitempty"`
OrganizationID string `json:"organization_id,omitempty"`
SpaceID string `json:"space_id,omitempty"`
} `json:"previous_values,omitempty"`
}
type UpdateResponse ¶
type UpdateResponse struct {
Operation Operation `json:"operation,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.