api

Documentation

Index

• Constants
• type BindResponse
• type BindingResponse
• type BindingsResponse
• type DeprovisionResponse
• type ErrorResponse
  • func (e ErrorResponse) Error() string
• type FileResponse
• type InstanceResponse
  • func (i InstanceResponse) IsBusy() bool
  • func (i InstanceResponse) IsGone() bool
  • func (i InstanceResponse) IsQuiet() bool
• type OopsResponse
• type ProvisionRequest
• type ProvisionResponse
• type PurgeResponse
• type TaskResponse
• type UnbindResponse
• type ViabilityResponse

Constants

const (
	QuietState          = "quiet"
	ProvisioningState   = "provisioning"
	DeprovisioningState = "deprovisioning"
	GoneState           = "gone"
	BindingState        = "binding"
	UnbindingState      = "unbinding"
)

Types

type BindResponse

type BindResponse struct {
	OK    string `json:"ok,omitempty"`
	Error string `json:"error,omitempty"`
	Ref   string `json:"ref"`
}

type BindingResponse

type BindingResponse struct {
	Binding map[string]interface{} `json:"binding"`
}

type BindingsResponse

type BindingsResponse struct {
	Bindings map[string]map[string]interface{} `json:"bindings"`
}

type DeprovisionResponse

type DeprovisionResponse struct {
	OK    string `json:"ok,omitempty"`
	Error string `json:"error,omitempty"`
	Gone  bool   `json:"gone"`
	Ref   string `json:"ref"`
}

type ErrorResponse

type ErrorResponse struct {
	Err string `json:"error"`
	Ref string `json:"ref"`
}

func (ErrorResponse) Error

func (e ErrorResponse) Error() string

type FileResponse

type FileResponse struct {
	Filename    string `json:"filename"`
	Summary     string `json:"summary"`
	Description string `json:"description"`
	Contents    string `json:"contents"`
}

type InstanceResponse

type InstanceResponse struct {
	ID      string                 `json:"id"`
	Service string                 `json:"service"`
	Plan    string                 `json:"plan"`
	Params  map[string]interface{} `json:"params"`

	State string `json:"state"`
	Log   string `json:"log"`

	Bindings map[string]map[string]interface{} `json:"bindings"`

	Tasks []TaskResponse `json:"tasks"`
}

func (InstanceResponse) IsBusy

func (i InstanceResponse) IsBusy() bool

func (InstanceResponse) IsGone

func (i InstanceResponse) IsGone() bool

func (InstanceResponse) IsQuiet

func (i InstanceResponse) IsQuiet() bool

type OopsResponse

type OopsResponse struct {
	ID      string `json:"id"`
	Handler string `json:"handler"`
	Remote  string `json:"remote"`
	Request string `json:"request"`
	Dated   string `json:"dated"`
	Message string `json:"message"`
}

type ProvisionRequest

type ProvisionRequest struct {
	Service string                 `json:"service"`
	Plan    string                 `json:"plan"`
	Params  map[string]interface{} `json:"params"`
}

type ProvisionResponse

type ProvisionResponse struct {
	OK    string `json:"ok,omitempty"`
	Error string `json:"error,omitempty"`
	Ref   string `json:"ref"`
}

type PurgeResponse

type PurgeResponse struct {
	OK    string `json:"ok,omitempty"`
	Error string `json:"error,omitempty"`
}

type TaskResponse

type TaskResponse struct {
	Task     string `json:"task"`
	Done     bool   `json:"done"`
	Exited   bool   `json:"exited"`
	ExitCode int    `json:"exit_code"`
	Ref      string `json:"ref"`
	Stdout   string `json:"stdout"`
	Stderr   string `json:"stderr"`
}

type UnbindResponse

type UnbindResponse struct {
	OK    string `json:"ok,omitempty"`
	Error string `json:"error,omitempty"`
	Ref   string `json:"ref"`
}

type ViabilityResponse

type ViabilityResponse struct {
	OK    string `json:"ok,omitempty"`
	Error string `json:"error,omitempty"`
}