api

Documentation

Overview

Package api implements the space-cloud client driver

Index

• type API
  • func New(project, url string, sslEnabled bool) *API
  • func (api *API) Call(service, endpoint string, params interface{}, timeout int) (*types.Response, error)
  • func (api *API) DB(dbAlias string) *db.DB
  • func (api *API) Filestore() *filestore.Filestore
  • func (api *API) QueueEvent(eventType string, payload map[string]interface{}) *eventing.Eventing
  • func (api *API) SetProjectID(project string)
  • func (api *API) SetToken(token string)

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API is the main API object to communicate with space cloud

func New

func New(project, url string, sslEnabled bool) *API

New initialised a new instance of the API object

func (*API) Call

func (api *API) Call(service, endpoint string, params interface{}, timeout int) (*types.Response, error)

Call invokes the specified function on the backend

func (*API) DB

func (api *API) DB(dbAlias string) *db.DB

DB creates a db client instance

func (*API) Filestore

func (api *API) Filestore() *filestore.Filestore

FileStore creates a FileStore instance

func (*API) QueueEvent

func (api *API) QueueEvent(eventType string, payload map[string]interface{}) *eventing.Eventing

QueueEvent creates a Eventing instance

func (*API) SetProjectID

func (api *API) SetProjectID(project string)

SetProjectID sets the project id to be used by the API

func (*API) SetToken

func (api *API) SetToken(token string)

SetToken sets the JWT token to be used in each request