components

Documentation

Index

• type Cache
• type FunctionServiceable
• type GetOptions
• type MatchDefinition
• type ServiceComponent
• type Serviceable

Types

type Cache

type Cache interface {
	Add(serviceable Serviceable) (Serviceable, error)
	Get(MatchDefinition, GetOptions) ([]Serviceable, error)
	Remove(Serviceable)
	Close()
}

type FunctionServiceable

type FunctionServiceable interface {
	Serviceable
	Config() *structureSpec.Function
}

type GetOptions

type GetOptions struct {
	Validation bool
	Branches   []string
	MatchIndex *matcherSpec.Index
}

GetOptions defines the parameters of serviceables returned by the Cache.Get() method

Validation: if set asset cid, and config commit are validated of the serviceable are validated

Branch: used by the validation method, if not set spec.DefaultBranch is used, currently this is the only branch handled by production deployed services.

MatchIndex: the required Match Index for a serviceable if not set then matcherSpec.HighMatch is used

type MatchDefinition

type MatchDefinition interface {
	String() string
	CachePrefix() string
}

type ServiceComponent

type ServiceComponent interface {
	substrate.Service
	CheckTns(MatchDefinition) ([]Serviceable, error)
	Cache() Cache
}

type Serviceable

type Serviceable interface {
	Match(MatchDefinition) matcherSpec.Index
	Validate(MatchDefinition) error
	Matcher() MatchDefinition
	Ready() error

	Project() string
	Application() string
	Id() string

	Commit() string
	Branch() string

	AssetId() string

	Service() ServiceComponent
	Close()
}