types

Documentation

Index

• Constants
• type LabelChange
• type Labels
• type Operation
• type OperationCategory
• type OperationState
• type ServiceBinding
• type ServiceBindings
• type ServiceInstance
• type ServiceInstances
• type ServiceOffering
• type ServiceOfferings
• type ServicePlan
• type ServicePlans

Constants

const AddLabelOperation = "add"

const RemoveLabelOperation = "remove"

const ResourceOperationsURL = "/operations"

const ServiceBindingsURL = "/v1/service_bindings"

const ServiceInstancesURL = "/v1/service_instances"

const ServiceOfferingsURL = "/v1/service_offerings"

const ServicePlansURL = "/v1/service_plans"

Types

type LabelChange

type LabelChange struct {
	Operation string   `json:"op"`
	Key       string   `json:"key"`
	Values    []string `json:"values"`
}

type Labels

type Labels map[string][]string

type Operation

type Operation struct {
	ID           string            `json:"id,omitempty" yaml:"id,omitempty"`
	Description  string            `json:"description,omitempty" yaml:"description,omitempty"`
	Type         OperationCategory `json:"type,omitempty" yaml:"type,omitempty"`
	State        OperationState    `json:"state,omitempty" yaml:"state,omitempty"`
	ResourceID   string            `json:"resource_id,omitempty" yaml:"resource_id,omitempty"`
	ResourceType string            `json:"resource_type,omitempty" yaml:"resource_type,omitempty"`
	Errors       json.RawMessage   `json:"errors,omitempty" yaml:"errors,omitempty"`
	Created      string            `json:"created_at,omitempty" yaml:"created_at,omitempty"`
	Updated      string            `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
	Labels       Labels            `json:"labels,omitempty" yaml:"labels,omitempty"`
}

Operation defines the data of a operation.

type OperationCategory

type OperationCategory string

const (
	CREATE OperationCategory = "create"
	UPDATE OperationCategory = "update"
	DELETE OperationCategory = "delete"
)

type OperationState

type OperationState string

const (
	PENDING    OperationState = "pending"
	SUCCEEDED  OperationState = "succeeded"
	INPROGRESS OperationState = "in progress"
	FAILED     OperationState = "failed"
)

type ServiceBinding

type ServiceBinding struct {
	ID             string `json:"id,omitempty" yaml:"id,omitempty"`
	Name           string `json:"name,omitempty" yaml:"name,omitempty"`
	CreatedAt      string `json:"created_at,omitempty" yaml:"created_at,omitempty"`
	UpdatedAt      string `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`
	Labels         Labels `json:"labels,omitempty" yaml:"labels,omitempty"`
	PagingSequence int64  `json:"-" yaml:"-"`

	Credentials json.RawMessage `json:"credentials,omitempty" yaml:"credentials,omitempty"`

	ServiceInstanceID   string `json:"service_instance_id" yaml:"service_instance_id,omitempty"`
	ServiceInstanceName string `json:"service_instance_name,omitempty" yaml:"service_instance_name,omitempty"`

	SyslogDrainURL  string          `json:"syslog_drain_url,omitempty" yaml:"syslog_drain_url,omitempty"`
	RouteServiceURL string          `json:"route_service_url,omitempty"`
	VolumeMounts    json.RawMessage `json:"-" yaml:"-"`
	Endpoints       json.RawMessage `json:"-" yaml:"-"`
	Context         json.RawMessage `json:"context,omitempty" yaml:"context,omitempty"`
	Parameters      json.RawMessage `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	BindResource    json.RawMessage `json:"-" yaml:"-"`

	Ready bool `json:"ready,omitempty" yaml:"ready,omitempty"`

	LastOperation *Operation `json:"last_operation,omitempty" yaml:"last_operation,omitempty"`
}

ServiceBinding defines the data of a service instance.

type ServiceBindings

type ServiceBindings struct {
	ServiceBindings []ServiceBinding `json:"items" yaml:"items"`
	Vertical        bool             `json:"-" yaml:"-"`
}

ServiceBindings wraps an array of service bindings

type ServiceInstance

type ServiceInstance struct {
	ID        string `json:"id,omitempty" yaml:"id,omitempty"`
	Name      string `json:"name,omitempty" yaml:"name,omitempty"`
	CreatedAt string `json:"created_at,omitempty" yaml:"created_at,omitempty"`
	UpdatedAt string `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`

	ServiceID     string `json:"service_id,omitempty" yaml:"service_id,omitempty"`
	ServicePlanID string `json:"service_plan_id,omitempty" yaml:"service_plan_id,omitempty"`
	PlatformID    string `json:"platform_id,omitempty" yaml:"platform_id,omitempty"`

	Parameters json.RawMessage `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	Labels     Labels          `json:"labels,omitempty" yaml:"labels,omitempty"`

	MaintenanceInfo json.RawMessage `json:"maintenance_info,omitempty" yaml:"-"`
	Context         json.RawMessage `json:"context,omitempty" yaml:"context,omitempty"`
	PreviousValues  json.RawMessage `json:"-" yaml:"-"`

	Ready  bool `json:"ready" yaml:"ready"`
	Usable bool `json:"usable" yaml:"usable"`
	Shared bool `json:"shared,omitempty" yaml:"shared,omitempty"`

	LastOperation *Operation `json:"last_operation,omitempty" yaml:"last_operation,omitempty"`
}

ServiceInstance defines the data of a service instance.

type ServiceInstances

type ServiceInstances struct {
	ServiceInstances []ServiceInstance `json:"items" yaml:"items"`
}

ServiceInstances wraps an array of service instances

type ServiceOffering

type ServiceOffering struct {
	ID          string `json:"id,omitempty" yaml:"id,omitempty"`
	Name        string `json:"name,omitempty" yaml:"name,omitempty"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	CreatedAt   string `json:"created_at,omitempty" yaml:"created_at,omitempty"`
	UpdatedAt   string `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`

	Bindable             bool   `json:"bindable,omitempty" yaml:"bindable,omitempty"`
	InstancesRetrievable bool   `json:"instances_retrievable,omitempty" yaml:"instances_retrievable,omitempty"`
	BindingsRetrievable  bool   `json:"bindings_retrievable,omitempty" yaml:"bindings_retrievable,omitempty"`
	AllowContextUpdates  bool   `json:"allow_context_updates,omitempty" yaml:"allow_context_updates,omitempty"`
	PlanUpdatable        bool   `json:"plan_updateable,omitempty" yaml:"plan_updateable,omitempty"`
	CatalogID            string `json:"catalog_id,omitempty" yaml:"catalog_id,omitempty"`
	CatalogName          string `json:"catalog_name,omitempty" yaml:"catalog_name,omitempty"`

	Tags     json.RawMessage `json:"tags,omitempty" yaml:"-"`
	Requires json.RawMessage `json:"requires,omitempty" yaml:"-"`
	Metadata json.RawMessage `json:"metadata,omitempty" yaml:"-"`

	BrokerID   string        `json:"broker_id,omitempty" yaml:"broker_id,omitempty"`
	BrokerName string        `json:"broker_name,omitempty" yaml:"broker_name,omitempty"`
	Plans      []ServicePlan `json:"plans,omitempty" yaml:"plans,omitempty"`
	Labels     Labels        `json:"labels,omitempty" yaml:"labels,omitempty"`
	Ready      bool          `json:"ready,omitempty" yaml:"ready,omitempty"`
	DataCenter string        `json:"data_center,omitempty" yaml:"data_center,omitempty"`
}

ServiceOffering defines the data of a service offering.

type ServiceOfferings

type ServiceOfferings struct {
	ServiceOfferings []ServiceOffering `json:"items" yaml:"items"`
}

ServiceOfferings wraps an array of service offerings

type ServicePlan

type ServicePlan struct {
	ID          string `json:"id,omitempty" yaml:"id,omitempty"`
	Name        string `json:"name,omitempty" yaml:"name,omitempty"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	CreatedAt   string `json:"created_at,omitempty" yaml:"created_at,omitempty"`
	UpdatedAt   string `json:"updated_at,omitempty" yaml:"updated_at,omitempty"`

	CatalogID     string `json:"catalog_id,omitempty" yaml:"catalog_id,omitempty"`
	CatalogName   string `json:"catalog_name,omitempty" yaml:"catalog_name,omitempty"`
	Free          bool   `json:"free,omitempty" yaml:"free,omitempty"`
	Bindable      bool   `json:"bindable,omitempty" yaml:"bindable,omitempty"`
	PlanUpdatable bool   `json:"plan_updateable,omitempty" yaml:"plan_updateable,omitempty"`

	Metadata json.RawMessage `json:"metadata,omitempty" yaml:"-"`
	Schemas  json.RawMessage `json:"schemas,omitempty" yaml:"-"`

	ServiceOfferingID string `json:"service_offering_id,omitempty" yaml:"service_offering_id,omitempty"`
	Labels            Labels `json:"labels,omitempty" yaml:"labels,omitempty"`
	Ready             bool   `json:"ready,omitempty" yaml:"ready,omitempty"`
}

ServicePlan defines the data of a service plan.

type ServicePlans

type ServicePlans struct {
	ServicePlans []ServicePlan `json:"items" yaml:"items"`
}

ServicePlans wraps an array of service plans