Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BindBody ¶
type BindBody struct {
ServiceID string `json:"service_id"`
PlanID string `json:"plan_id"`
Database Database `json:"parameters"`
}
BindBody represents the expected request body for binding.
type BindResponse ¶
type BindResponse struct {
Credentials interface{} `json:"credentials, omitempty"`
}
BindResponse contains the credentials that may be used by applications or users to access the database service.
type Catalog ¶
type Catalog struct {
Services []Service `json:"services"`
}
Catalog contains the databases services and their description.
type Credentials ¶
type Credentials struct {
ConnectionString string `json:"connection_string"`
UserName string `json:"username"`
Password string `json:"password"`
Hostname string `json:"hostname"`
DatabaseName string `json:"database_name"`
}
Credentials represents the set of information used by an application or a user to utilize the service instance.
type Database ¶
type Database struct {
Name string `json:"name"`
UserName string `json:"username"`
Password string `json:"password"`
}
Database contains the configuration options for database service binding.
type DeprovisionResponse ¶
type DeprovisionResponse struct {
Operation string `json:"operation, omitempty"`
}
DeprovisionResponse expected {} but may return an identifier representing the operation.
type ErrorResponse ¶
type ErrorResponse struct {
Description string `json:"description"`
}
ErrorResponse represents the error response during the provision and deprovision implementation.
type ProvisionBody ¶
type ProvisionBody struct {
ServiceID string `json:"service_id"`
PlanID string `json:"plan_id"`
OrganizationID string `json:"organization_guid"`
SpaceID string `json:"space_guid"`
}
ProvisionBody represents the expected request body for provisioning.
type ProvisionResponse ¶
type ProvisionResponse struct {
DashboardURL string `json:"dashboard_url, omitempty"`
Operation string `json:"operation, omitempty"`
}
ProvisionResponse could be populated with the URL of a web-based portal for the service instance management.
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"`
PlanUpdateable bool `json:"plan_updateable, omitempty"`
Plans []ServicePlan `json:"plans"`
Metadata interface{} `json:"metadata, omitempty"`
DashboardClient interface{} `json:"dashboard_client, omitempty"`
}
Service represents a databases service offering.
type ServicePlan ¶
type ServicePlan struct {
Name string `json:"name"`
ID string `json:"id"`
Description string `json:"description"`
Metadata interface{} `json:"metadata, omitempty"`
Free bool `json:"free, omitempty"`
Bindable bool `json:"bindable, omitempty"`
}
ServicePlan represents the different plans available for a database service.
Source Files