Documentation
¶
Overview ¶
Package registry stores definition registrations for the greenfield integration runtime
Index ¶
- Variables
- type Builder
- type Registry
- func (r *Registry) Catalog() []types.DefinitionSpec
- func (r *Registry) Client(id string, clientID types.ClientID) (types.ClientRegistration, error)
- func (r *Registry) Definition(id string) (types.Definition, bool)
- func (r *Registry) Definitions() []types.Definition
- func (r *Registry) Listeners() []types.OperationRegistration
- func (r *Registry) Operation(id string, name string) (types.OperationRegistration, error)
- func (r *Registry) Register(def types.Definition) error
- func (r *Registry) RegisterAll(builders ...Builder) error
- func (r *Registry) Webhook(id string, name string) (types.WebhookRegistration, error)
- func (r *Registry) WebhookEvent(id string, webhookName string, eventName string) (types.WebhookEventRegistration, error)
- func (r *Registry) WebhookListeners() []types.WebhookEventRegistration
Constants ¶
This section is empty.
Variables ¶
var ( // ErrDefinitionIDRequired indicates a definition is missing its canonical identifier ErrDefinitionIDRequired = errors.New("integrations/registry: definition id required") // ErrDefinitionAlreadyRegistered indicates the definition ID is already present ErrDefinitionAlreadyRegistered = errors.New("integrations/registry: definition already registered") // ErrDefinitionNotFound indicates the requested definition does not exist ErrDefinitionNotFound = errors.New("integrations/registry: definition not found") // ErrClientRequired indicates a client registration is missing its identity ErrClientRequired = errors.New("integrations/registry: client required") // ErrClientNotFound indicates the requested client does not exist ErrClientNotFound = errors.New("integrations/registry: client not found") // ErrConnectionCredentialRefRequired indicates a connection registration is missing its credential ref ErrConnectionCredentialRefRequired = errors.New("integrations/registry: connection credential ref required") // ErrOperationNotFound indicates the requested operation does not exist ErrOperationNotFound = errors.New("integrations/registry: operation not found") // ErrOperationHandlerRequired indicates an operation registration is missing both Handle and IngestHandle ErrOperationHandlerRequired = errors.New("integrations/registry: operation handler required") // ErrOperationHandlerAmbiguous indicates an operation registration specifies both Handle and IngestHandle ErrOperationHandlerAmbiguous = errors.New("integrations/registry: operation must specify exactly one of Handle or IngestHandle") // ErrIngestContractsRequired indicates an IngestHandle is registered without any Ingest contracts ErrIngestContractsRequired = errors.New("integrations/registry: IngestHandle requires at least one Ingest contract") // ErrWebhookEventResolverRequired indicates a webhook registration is missing its event resolver ErrWebhookEventResolverRequired = errors.New("integrations/registry: webhook event resolver required") // ErrWebhookEventHandlerRequired indicates a webhook event registration is missing its handler ErrWebhookEventHandlerRequired = errors.New("integrations/registry: webhook event handler required") // ErrWebhookNotFound indicates the requested webhook or webhook event does not exist ErrWebhookNotFound = errors.New("integrations/registry: webhook not found") // ErrOperatorConfigSchemaRequired indicates a definition has an operator config with no schema ErrOperatorConfigSchemaRequired = errors.New("integrations/registry: operator config schema required") // ErrCredentialSchemaRequired indicates a definition has a credentials block with no schema ErrCredentialSchemaRequired = errors.New("integrations/registry: credential schema required") // ErrCredentialRefNotDeclared indicates a client references a credential ref not declared by the definition ErrCredentialRefNotDeclared = errors.New("integrations/registry: client credential ref not declared by definition") // ErrConnectionCredentialRefNotDeclared indicates a connection references a credential ref not declared by the definition ErrConnectionCredentialRefNotDeclared = errors.New("integrations/registry: connection credential ref not declared by definition") // ErrConnectionClientRefNotDeclared indicates a connection references a client ref not declared by the definition ErrConnectionClientRefNotDeclared = errors.New("integrations/registry: connection client ref not declared by definition") // ErrConnectionValidationOperationNotDeclared indicates a connection validation operation does not exist on the definition ErrConnectionValidationOperationNotDeclared = errors.New("integrations/registry: connection validation operation not declared by definition") // ErrConnectionAuthCredentialRefNotDeclared indicates a connection auth registration references an undeclared credential ref ErrConnectionAuthCredentialRefNotDeclared = errors.New("integrations/registry: connection auth credential ref not declared by connection") // ErrConnectionDisconnectCredentialRefNotDeclared indicates a connection disconnect registration references an undeclared credential ref ErrConnectionDisconnectCredentialRefNotDeclared = errors.New("integrations/registry: connection disconnect credential ref not declared by connection") // ErrUserInputSchemaRequired indicates a definition has a user input block with no schema ErrUserInputSchemaRequired = errors.New("integrations/registry: user input schema required") // ErrBuilderNil indicates a builder dependency was nil ErrBuilderNil = errors.New("integrations/registry: builder is nil") )
Functions ¶
This section is empty.
Types ¶
type Builder ¶ added in v1.15.0
type Builder func() (types.Definition, error)
Builder builds one manifest-backed definition
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry is the in-memory index of registered definitions
func (*Registry) Catalog ¶ added in v1.15.0
func (r *Registry) Catalog() []types.DefinitionSpec
Catalog returns all definition specs in stable id order
func (*Registry) Definition ¶ added in v1.15.0
func (r *Registry) Definition(id string) (types.Definition, bool)
Definition returns one definition by canonical identifier
func (*Registry) Definitions ¶ added in v1.15.0
func (r *Registry) Definitions() []types.Definition
Definitions returns all registered definitions in stable id order
func (*Registry) Listeners ¶ added in v1.15.0
func (r *Registry) Listeners() []types.OperationRegistration
Listeners returns all operation registrations in stable topic order
func (*Registry) Operation ¶ added in v1.15.0
Operation returns one operation registration for a definition
func (*Registry) Register ¶ added in v1.15.0
func (r *Registry) Register(def types.Definition) error
Register adds one definition to the registry
func (*Registry) RegisterAll ¶ added in v1.15.0
RegisterAll builds and registers every supplied definition builder in order
func (*Registry) Webhook ¶ added in v1.15.0
Webhook returns one webhook registration for a definition
func (*Registry) WebhookEvent ¶ added in v1.15.0
func (r *Registry) WebhookEvent(id string, webhookName string, eventName string) (types.WebhookEventRegistration, error)
WebhookEvent returns one webhook event registration for a definition
func (*Registry) WebhookListeners ¶ added in v1.15.0
func (r *Registry) WebhookListeners() []types.WebhookEventRegistration
WebhookListeners returns all webhook event registrations in stable topic order