types

Documentation

Overview

Package types contains the Service Manager web entities

Index

• type Basic
• type Broker
  • func (b *Broker) MarshalJSON() ([]byte, error)
  • func (b *Broker) Validate() error
• type Brokers
• type Credentials
  • func GenerateCredentials() (*Credentials, error)
  • func (c *Credentials) MarshalJSON() ([]byte, error)
  • func (c *Credentials) Validate() error
• type Labels
  • func (l Labels) Validate() error
• type Platform
  • func (p *Platform) MarshalJSON() ([]byte, error)
  • func (p *Platform) Validate() error
• type ServiceOffering
  • func (so *ServiceOffering) MarshalJSON() ([]byte, error)
  • func (so *ServiceOffering) Validate() error
• type ServiceOfferings
• type ServicePlan
  • func (sp *ServicePlan) MarshalJSON() ([]byte, error)
  • func (sp *ServicePlan) Validate() error
• type ServicePlans
• type Visibilities
• type Visibility
  • func (v *Visibility) MarshalJSON() ([]byte, error)
  • func (v *Visibility) Validate() error

Types

type Basic

type Basic struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

Basic basic credentials

type Broker

type Broker struct {
	ID          string       `json:"id"`
	Name        string       `json:"name"`
	Description string       `json:"description"`
	CreatedAt   time.Time    `json:"created_at"`
	UpdatedAt   time.Time    `json:"updated_at"`
	BrokerURL   string       `json:"broker_url"`
	Credentials *Credentials `json:"credentials,omitempty" structs:"-"`

	Services []*ServiceOffering `json:"services,omitempty" structs:"-"`

	Labels Labels `json:"labels,omitempty"`
}

Broker broker struct

func (*Broker) MarshalJSON

func (b *Broker) MarshalJSON() ([]byte, error)

MarshalJSON override json serialization for http response

func (*Broker) Validate

func (b *Broker) Validate() error

Validate implements InputValidator and verifies all mandatory fields are populated

type Brokers

type Brokers struct {
	Brokers []*Broker `json:"service_brokers"`
}

Brokers struct

type Credentials

type Credentials struct {
	Basic   *Basic `json:"basic,omitempty"`
	Details []byte `json:"-"`
}

Credentials credentials

func GenerateCredentials

func GenerateCredentials() (*Credentials, error)

GenerateCredentials return user and password

func (*Credentials) MarshalJSON

func (c *Credentials) MarshalJSON() ([]byte, error)

func (*Credentials) Validate

func (c *Credentials) Validate() error

Validate implements InputValidator and verifies all mandatory fields are populated

type Labels

type Labels map[string][]string

Labels represents key values pairs associated with resources

func (Labels) Validate

func (l Labels) Validate() error

type Platform

type Platform struct {
	ID          string       `json:"id"`
	Type        string       `json:"type"`
	Name        string       `json:"name"`
	Description string       `json:"description"`
	CreatedAt   time.Time    `json:"created_at"`
	UpdatedAt   time.Time    `json:"updated_at"`
	Credentials *Credentials `json:"credentials,omitempty"`
}

Platform platform struct

func (*Platform) MarshalJSON

func (p *Platform) MarshalJSON() ([]byte, error)

MarshalJSON override json serialization for http response

func (*Platform) Validate

func (p *Platform) Validate() error

Validate implements InputValidator and verifies all mandatory fields are populated

type ServiceOffering

type ServiceOffering struct {
	ID          string    `json:"id"`
	Name        string    `json:"name"`
	Description string    `json:"description"`
	CreatedAt   time.Time `json:"created_at"`
	UpdatedAt   time.Time `json:"updated_at"`

	Bindable             bool   `json:"bindable"`
	InstancesRetrievable bool   `json:"instances_retrievable"`
	BindingsRetrievable  bool   `json:"bindings_retrievable"`
	PlanUpdatable        bool   `json:"plan_updateable"`
	CatalogID            string `json:"catalog_id"`
	CatalogName          string `json:"catalog_name"`

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

	BrokerID string         `json:"broker_id"`
	Plans    []*ServicePlan `json:"plans"`
}

Service Offering struct

func (*ServiceOffering) MarshalJSON

func (so *ServiceOffering) MarshalJSON() ([]byte, error)

MarshalJSON override json serialization for http response

func (*ServiceOffering) Validate

func (so *ServiceOffering) Validate() error

Validate implements InputValidator and verifies all mandatory fields are populated

type ServiceOfferings

type ServiceOfferings struct {
	ServiceOfferings []*ServiceOffering `json:"services"`
}

ServiceOfferings struct

type ServicePlan

type ServicePlan struct {
	ID          string    `json:"id"`
	Name        string    `json:"name"`
	Description string    `json:"description"`
	CreatedAt   time.Time `json:"created_at"`
	UpdatedAt   time.Time `json:"updated_at"`

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

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

	ServiceOfferingID string `json:"service_offering_id"`
}

Service Plan struct

func (*ServicePlan) MarshalJSON

func (sp *ServicePlan) MarshalJSON() ([]byte, error)

MarshalJSON override json serialization for http response

func (*ServicePlan) Validate

func (sp *ServicePlan) Validate() error

Validate implements InputValidator and verifies all mandatory fields are populated

type ServicePlans

type ServicePlans struct {
	ServicePlans []*ServicePlan `json:"service_plans"`
}

ServicePlans struct

type Visibilities

type Visibilities struct {
	Visibilities []*Visibility `json:"visibilities"`
}

Visibilities struct

type Visibility

type Visibility struct {
	ID            string    `json:"id"`
	PlatformID    string    `json:"platform_id"`
	ServicePlanID string    `json:"service_plan_id"`
	CreatedAt     time.Time `json:"created_at"`
	UpdatedAt     time.Time `json:"updated_at"`
	Labels        Labels    `json:"labels,omitempty"`
}

Visibility struct

func (*Visibility) MarshalJSON

func (v *Visibility) MarshalJSON() ([]byte, error)

MarshalJSON override json serialization for http response

func (*Visibility) Validate

func (v *Visibility) Validate() error

Validate implements InputValidator and verifies all mandatory fields are populated