pipeline

Documentation

Overview

The package pipeline defines the api. Each of the routes does a very similar pattern of decode, transform and send to domain service.

Index

• Variables
• func Register(service *Service)
• type CreatePipelineRequest
• type CreatePipelineResponse
• type DeletePipelineResponse
• type GetPipelineResponse
• type Job
• type Pipeline
• type Service
  • func NewService(service *pipeline.Service) *Service
  • func (s *Service) CreatePipeline(ctx context.Context) (any, error)
  • func (s *Service) DeletePipeline(ctx context.Context) (any, error)
  • func (s *Service) GetPipeline(ctx context.Context) (any, error)
  • func (s *Service) TriggerPipeline(ctx context.Context) (any, error)
  • func (s *Service) UpdatePipeline(ctx context.Context) (any, error)
• type TriggerPipelineResponse
• type UpdatePipelineRequest
• type UpdatePipelineResponse

Variables

var Module = fx.Options(
	fx.Invoke(Register),
	fx.Provide(NewService),
)

Module for fx.

Functions

func Register

func Register(service *Service)

Register routes.

Types

type CreatePipelineRequest

type CreatePipelineRequest struct {
	Pipeline *Pipeline `json:"pipeline,omitempty"`
}

CreatePipelineRequest with a definition.

type CreatePipelineResponse

type CreatePipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

CreatePipelineResponse a map of meta and the new pipeline.

type DeletePipelineResponse

type DeletePipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

DeletePipelineResponse a map of meta and the updated pipeline.

type GetPipelineResponse

type GetPipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

GetPipelineResponse a map of meta and the pipeline.

type Job

type Job struct {
	Name  string   `json:"name,omitempty"`
	Steps []string `json:"steps,omitempty"`
}

Job of the pipeline.

type Pipeline

type Pipeline struct {
	Name string `json:"name,omitempty"`
	Jobs []*Job `json:"jobs,omitempty"`
	ID   uint64 `json:"id,omitempty"`
}

Pipeline to be executed.

type Service

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

Service for pipeline.

This type is the main type that builds all of the api.

func NewService

func NewService(service *pipeline.Service) *Service

NewService for pipeline.

func (*Service) CreatePipeline

func (s *Service) CreatePipeline(ctx context.Context) (any, error)

CreatePipeline for the api.

func (*Service) DeletePipeline

func (s *Service) DeletePipeline(ctx context.Context) (any, error)

DeletePipeline for the api.

func (*Service) GetPipeline

func (s *Service) GetPipeline(ctx context.Context) (any, error)

GetPipeline for the api.

func (*Service) TriggerPipeline

func (s *Service) TriggerPipeline(ctx context.Context) (any, error)

TriggerPipeline for the api.

func (*Service) UpdatePipeline

func (s *Service) UpdatePipeline(ctx context.Context) (any, error)

UpdatePipeline for the api.

type TriggerPipelineResponse

type TriggerPipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

TriggerPipelineResponse a map of meta and the pipeline with the output in steps.

type UpdatePipelineRequest

type UpdatePipelineRequest struct {
	Pipeline *Pipeline `json:"pipeline,omitempty"`
}

UpdatePipelineRequest with a definition.

type UpdatePipelineResponse

type UpdatePipelineResponse struct {
	Meta     map[string]string `json:"meta,omitempty"`
	Pipeline *Pipeline         `json:"pipeline,omitempty"`
}

UpdatePipelineResponse a map of meta and the updated pipeline.