pipeline

Documentation

Overview

Package pipeline interacts with the api. The service does not check the responses from the api, as this is tested at the api.

Index

• Variables
• func NewClient() *resty.Client
• func Start(lc fx.Lifecycle, service *Service, logger *zap.Logger) error
• type Service
  • func NewService(client *resty.Client, cfg *pipeline.Config) (*Service, error)
  • func (s *Service) CreatePipeline(ctx context.Context) context.Context
  • func (s *Service) DeletePipeline(ctx context.Context) context.Context
  • func (s *Service) GetPipeline(ctx context.Context) context.Context
  • func (s *Service) TriggerPipeline(ctx context.Context) context.Context
  • func (s *Service) UpdatePipeline(ctx context.Context) context.Context

Variables

var (
	// CreateFlag defines the pipeline path to create a pipeline.
	CreateFlag = flags.String()

	// GetFlag defines a pipeline id to be retrieved.
	GetFlag = flags.String()

	// GetFlag defines the id and pipeline path to update.
	UpdateFlag = flags.String()

	// DeleteFlag defines a pipeline to be deleted by the provided id.
	DeleteFlag = flags.String()

	// TriggerFlag defines a pipeline to be triggered by the provided id.
	TriggerFlag = flags.String()
)

var ErrInvalidUpdateFormat = errors.New("invalid update format, this should be id:path")

ErrInvalidUpdateFormat indicates that the format is not how it's expected.

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

Module for fx.

Functions

func NewClient

func NewClient() *resty.Client

NewClient for pipeline.

func Start

func Start(lc fx.Lifecycle, service *Service, logger *zap.Logger) error

Start for pipeline.

Types

type Service

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

Service for pipeline.

func NewService

func NewService(client *resty.Client, cfg *pipeline.Config) (*Service, error)

NewService for pipeline.

func (*Service) CreatePipeline

func (s *Service) CreatePipeline(ctx context.Context) context.Context

CreatePipeline for cmd.

func (*Service) DeletePipeline

func (s *Service) DeletePipeline(ctx context.Context) context.Context

DeletePipeline for cmd.

func (*Service) GetPipeline

func (s *Service) GetPipeline(ctx context.Context) context.Context

GetPipeline for cmd.

func (*Service) TriggerPipeline

func (s *Service) TriggerPipeline(ctx context.Context) context.Context

TriggerPipeline for cmd.

func (*Service) UpdatePipeline

func (s *Service) UpdatePipeline(ctx context.Context) context.Context

UpdatePipeline for cmd.