webhook

Documentation

Index

• Variables
• func NewExternalInitiatorManager(db *gorm.DB) *externalInitiatorManager
• func ValidatedWebhookSpec(tomlString string, externalInitiatorManager ExternalInitiatorManager) (job.Job, error)
• type Delegate
  • func NewDelegate(runner pipeline.Runner, externalInitiatorManager ExternalInitiatorManager) *Delegate
  • func (d *Delegate) JobType() job.Type
  • func (d *Delegate) OnJobCreated(spec job.Job)
  • func (d *Delegate) OnJobDeleted(spec job.Job)
  • func (d *Delegate) ServicesForSpec(spec job.Job) ([]job.Service, error)
  • func (d *Delegate) WebhookJobRunner() JobRunner
• type ExternalInitiatorManager
• type JobRunner
• type JobSpecNotice
  • func NewJobSpecNotice(initiator models.Initiator, js models.JobSpec) (*JobSpecNotice, error)
• type JobSpecNoticeV2
• type NullExternalInitiatorManager
  • func (NullExternalInitiatorManager) DeleteJob(jobID models.JobID) error
  • func (NullExternalInitiatorManager) DeleteJobV2(jb job.Job) error
  • func (NullExternalInitiatorManager) FindExternalInitiatorByName(name string) (models.ExternalInitiator, error)
  • func (NullExternalInitiatorManager) Notify(models.JobSpec) error
  • func (NullExternalInitiatorManager) NotifyV2(jobUUID uuid.UUID, initrName string, initrSpec *models.JSON) error

Variables

var ErrJobNotExists = errors.New("job does not exist")

var ErrMissingJobID = errors.New("missing job ID")

Functions

func NewExternalInitiatorManager

func NewExternalInitiatorManager(db *gorm.DB) *externalInitiatorManager

NewExternalInitiatorManager returns the concrete externalInitiatorManager

func ValidatedWebhookSpec

func ValidatedWebhookSpec(tomlString string, externalInitiatorManager ExternalInitiatorManager) (job.Job, error)

Types

type Delegate

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

func NewDelegate

func NewDelegate(runner pipeline.Runner, externalInitiatorManager ExternalInitiatorManager) *Delegate

func (*Delegate) JobType

func (d *Delegate) JobType() job.Type

func (*Delegate) OnJobCreated

func (d *Delegate) OnJobCreated(spec job.Job)

func (*Delegate) OnJobDeleted

func (d *Delegate) OnJobDeleted(spec job.Job)

func (*Delegate) ServicesForSpec

func (d *Delegate) ServicesForSpec(spec job.Job) ([]job.Service, error)

func (*Delegate) WebhookJobRunner

func (d *Delegate) WebhookJobRunner() JobRunner

type ExternalInitiatorManager

type ExternalInitiatorManager interface {
	Notify(models.JobSpec) error
	NotifyV2(jobID uuid.UUID, initrName string, initrSpec *models.JSON) error
	DeleteJob(jobID models.JobID) error
	DeleteJobV2(job job.Job) error
	FindExternalInitiatorByName(name string) (models.ExternalInitiator, error)
}

ExternalInitiatorManager manages HTTP requests to remote external initiators

type JobRunner

type JobRunner interface {
	RunJob(ctx context.Context, jobUUID uuid.UUID, requestBody string, meta pipeline.JSONSerializable) (int64, error)
}

type JobSpecNotice

type JobSpecNotice struct {
	JobID  models.JobID `json:"jobId"`
	Type   string       `json:"type"`
	Params models.JSON  `json:"params,omitempty"`
}

JobSpecNotice is sent to the External Initiator when JobSpecs are created.

func NewJobSpecNotice

func NewJobSpecNotice(initiator models.Initiator, js models.JobSpec) (*JobSpecNotice, error)

NewJobSpecNotice returns a new JobSpec.

type JobSpecNoticeV2

type JobSpecNoticeV2 struct {
	JobID  uuid.UUID   `json:"jobId"`
	Type   string      `json:"type"`
	Params models.JSON `json:"params,omitempty"`
}

JobSpecNotice is sent to the External Initiator when JobSpecs are created.

type NullExternalInitiatorManager

type NullExternalInitiatorManager struct{}

func (NullExternalInitiatorManager) DeleteJob

func (NullExternalInitiatorManager) DeleteJob(jobID models.JobID) error

func (NullExternalInitiatorManager) DeleteJobV2

func (NullExternalInitiatorManager) DeleteJobV2(jb job.Job) error

func (NullExternalInitiatorManager) FindExternalInitiatorByName

func (NullExternalInitiatorManager) FindExternalInitiatorByName(name string) (models.ExternalInitiator, error)

func (NullExternalInitiatorManager) Notify

func (NullExternalInitiatorManager) Notify(models.JobSpec) error

func (NullExternalInitiatorManager) NotifyV2

func (NullExternalInitiatorManager) NotifyV2(jobUUID uuid.UUID, initrName string, initrSpec *models.JSON) error