Documentation
¶
Index ¶
- Variables
- type QuickstartRegistryResource
- func (r *QuickstartRegistryResource) ExecuteQuickstart(ctx context.Context, req *s4wave_quickstart_registry.ExecuteQuickstartRequest) (*s4wave_quickstart_registry.ExecuteQuickstartResponse, error)
- func (r *QuickstartRegistryResource) GetMux() srpc.Invoker
- func (r *QuickstartRegistryResource) ListQuickstarts(ctx context.Context, req *s4wave_quickstart_registry.ListQuickstartsRequest) (*s4wave_quickstart_registry.ListQuickstartsResponse, error)
- func (r *QuickstartRegistryResource) LookupRegistration(quickstartID string) *s4wave_quickstart_registry.QuickstartRegistration
- func (r *QuickstartRegistryResource) RegisterQuickstart(ctx context.Context, req *s4wave_quickstart_registry.RegisterQuickstartRequest) (*s4wave_quickstart_registry.RegisterQuickstartResponse, error)
- func (r *QuickstartRegistryResource) WatchQuickstarts(req *s4wave_quickstart_registry.WatchQuickstartsRequest, ...) error
Constants ¶
This section is empty.
Variables ¶
var ErrCategoryRequired = errors.New("category is required")
ErrCategoryRequired is returned when the category field is empty.
var ErrDescriptionRequired = errors.New("description is required")
ErrDescriptionRequired is returned when the description field is empty.
var ErrNameRequired = errors.New("name is required")
ErrNameRequired is returned when the name field is empty.
var ErrPluginIdRequired = errors.New("plugin_id is required")
ErrPluginIdRequired is returned when the plugin_id field is empty.
ErrQuickstartExecutionUnavailable is returned when no plugin bus is configured.
var ErrQuickstartIdAlreadyRegistered = errors.New("quickstart_id is already registered")
ErrQuickstartIdAlreadyRegistered is returned when quickstart_id is already registered.
var ErrQuickstartIdRequired = errors.New("quickstart_id is required")
ErrQuickstartIdRequired is returned when the quickstart_id field is empty.
var ErrQuickstartNotRegistered = errors.New("quickstart_id is not registered")
ErrQuickstartNotRegistered is returned when quickstart_id is not registered.
var ErrRegistrationRequired = errors.New("registration is required")
ErrRegistrationRequired is returned when no registration is provided.
var ErrSpaceResourceIdRequired = errors.New("space_resource_id is required")
ErrSpaceResourceIdRequired is returned when space_resource_id is empty.
var ErrSpaceResourceRequired = errors.New("space resource is required")
ErrSpaceResourceRequired is returned when the resource is not a Space resource.
Functions ¶
This section is empty.
Types ¶
type QuickstartRegistryResource ¶
type QuickstartRegistryResource struct {
// contains filtered or unexported fields
}
QuickstartRegistryResource provides an in-memory Quickstart registry. Plugins register Quickstarts via RegisterQuickstart and watch for changes via WatchQuickstarts.
func NewQuickstartRegistryResource ¶
func NewQuickstartRegistryResource( le *logrus.Entry, b bus.Bus, ) *QuickstartRegistryResource
NewQuickstartRegistryResource creates a new QuickstartRegistryResource.
func (*QuickstartRegistryResource) ExecuteQuickstart ¶
func (r *QuickstartRegistryResource) ExecuteQuickstart( ctx context.Context, req *s4wave_quickstart_registry.ExecuteQuickstartRequest, ) (*s4wave_quickstart_registry.ExecuteQuickstartResponse, error)
ExecuteQuickstart runs a registered Quickstart seed handler against a mounted Space.
func (*QuickstartRegistryResource) GetMux ¶
func (r *QuickstartRegistryResource) GetMux() srpc.Invoker
GetMux returns the rpc mux.
func (*QuickstartRegistryResource) ListQuickstarts ¶
func (r *QuickstartRegistryResource) ListQuickstarts( ctx context.Context, req *s4wave_quickstart_registry.ListQuickstartsRequest, ) (*s4wave_quickstart_registry.ListQuickstartsResponse, error)
ListQuickstarts returns all registered Quickstarts.
func (*QuickstartRegistryResource) LookupRegistration ¶
func (r *QuickstartRegistryResource) LookupRegistration( quickstartID string, ) *s4wave_quickstart_registry.QuickstartRegistration
LookupRegistration finds a registration by quickstartID.
func (*QuickstartRegistryResource) RegisterQuickstart ¶
func (r *QuickstartRegistryResource) RegisterQuickstart( ctx context.Context, req *s4wave_quickstart_registry.RegisterQuickstartRequest, ) (*s4wave_quickstart_registry.RegisterQuickstartResponse, error)
RegisterQuickstart registers a Quickstart from a plugin.
func (*QuickstartRegistryResource) WatchQuickstarts ¶
func (r *QuickstartRegistryResource) WatchQuickstarts( req *s4wave_quickstart_registry.WatchQuickstartsRequest, strm s4wave_quickstart_registry.SRPCQuickstartRegistryResourceService_WatchQuickstartsStream, ) error
WatchQuickstarts streams all registered Quickstarts.