resources

Documentation

Index

• Variables
• func IsBuildEnvirnonment() bool
• func NewBucket(name string, permissions ...BucketPermission) (storage.Bucket, error)
• func NewCollection(name string, permissions ...CollectionPermission) (documents.CollectionRef, error)
• func NewQueue(name string, permissions ...QueuePermission) (queues.Queue, error)
• func NewSchedule(name, rate string, handlers ...faas.EventMiddleware) error
• func NewSecret(name string, permissions ...SecretPermission) (secrets.SecretRef, error)
• func Run() error
• type Api
  • func NewApi(name string) Api
• type BucketPermission
• type CollectionPermission
• type Manager
  • func New() Manager
• type QueuePermission
• type Route
  • func NewRoute(apiName, apiPath string) Route
• type SecretPermission
• type Starter
• type Topic
  • func NewTopic(name string, permissions ...TopicPermission) (Topic, error)
• type TopicPermission

Variables

var (
	BucketEverything []BucketPermission = []BucketPermission{BucketReading, BucketWriting, BucketDeleting}
)

var (
	CollectionEverything []CollectionPermission = []CollectionPermission{CollectionReading, CollectionWriting, CollectionDeleting}
)

var (
	QueueEverything []QueuePermission = []QueuePermission{QueueSending, QueueReceving}
)

var (
	SecretEverything []SecretPermission = []SecretPermission{SecretReading, SecretWriting}
)

Functions

func IsBuildEnvirnonment

func IsBuildEnvirnonment() bool

func NewBucket

func NewBucket(name string, permissions ...BucketPermission) (storage.Bucket, error)

func NewCollection

func NewCollection(name string, permissions ...CollectionPermission) (documents.CollectionRef, error)

func NewQueue

func NewQueue(name string, permissions ...QueuePermission) (queues.Queue, error)

func NewSchedule

func NewSchedule(name, rate string, handlers ...faas.EventMiddleware) error

func NewSecret

func NewSecret(name string, permissions ...SecretPermission) (secrets.SecretRef, error)

func Run

func Run() error

Types

type Api

type Api interface {
	Get(string, ...faas.HttpMiddleware)
	Put(string, ...faas.HttpMiddleware)
	Patch(string, ...faas.HttpMiddleware)
	Post(string, ...faas.HttpMiddleware)
	Delete(string, ...faas.HttpMiddleware)
	Options(string, ...faas.HttpMiddleware)
}

func NewApi

func NewApi(name string) Api

type BucketPermission

type BucketPermission string

const (
	BucketReading  BucketPermission = "reading"
	BucketWriting  BucketPermission = "writing"
	BucketDeleting BucketPermission = "deleting"
)

type CollectionPermission

type CollectionPermission string

const (
	CollectionReading  CollectionPermission = "reading"
	CollectionWriting  CollectionPermission = "writing"
	CollectionDeleting CollectionPermission = "deleting"
)

type Manager

type Manager interface {
	Run() error
	NewApi(name string) Api
	NewBucket(name string, permissions ...BucketPermission) (storage.Bucket, error)
	NewCollection(name string, permissions ...CollectionPermission) (documents.CollectionRef, error)
	NewSecret(name string, permissions ...SecretPermission) (secrets.SecretRef, error)
	NewQueue(name string, permissions ...QueuePermission) (queues.Queue, error)
	NewSchedule(name, rate string, handlers ...faas.EventMiddleware) error
	NewTopic(name string, permissions ...TopicPermission) (Topic, error)
}

func New

func New() Manager

type QueuePermission

type QueuePermission string

const (
	QueueSending  QueuePermission = "sending"
	QueueReceving QueuePermission = "receiving"
)

type Route

type Route interface {
	Get(handler ...faas.HttpMiddleware)
	Patch(handler ...faas.HttpMiddleware)
	Put(handler ...faas.HttpMiddleware)
	Post(handler ...faas.HttpMiddleware)
	Delete(handler ...faas.HttpMiddleware)
	Options(handler ...faas.HttpMiddleware)
}

func NewRoute

func NewRoute(apiName, apiPath string) Route

type SecretPermission

type SecretPermission string

const (
	SecretReading SecretPermission = "reading"
	SecretWriting SecretPermission = "writing"
)

type Starter

type Starter interface {
	Start() error
}

type Topic

type Topic interface {
	events.Topic
	Subscribe(...faas.EventMiddleware)
}

func NewTopic

func NewTopic(name string, permissions ...TopicPermission) (Topic, error)

type TopicPermission

type TopicPermission string

const (
	TopicPublishing TopicPermission = "publishing"
)