api

Documentation

Index

• Constants
• func New(_ *any.Any, logger *zap.Logger, scope tally.Scope) (module.Module, error)
• type Service
  • func (s *Service) CancelExperimentRun(ctx context.Context, req *experimentation.CancelExperimentRunRequest) (*experimentation.CancelExperimentRunResponse, error)
  • func (s *Service) CreateExperiment(ctx context.Context, req *experimentation.CreateExperimentRequest) (*experimentation.CreateExperimentResponse, error)
  • func (s *Service) CreateOrGetExperiment(ctx context.Context, req *experimentation.CreateOrGetExperimentRequest) (*experimentation.CreateOrGetExperimentResponse, error)
  • func (s *Service) GetExperimentRunDetails(ctx context.Context, request *experimentation.GetExperimentRunDetailsRequest) (*experimentation.GetExperimentRunDetailsResponse, error)
  • func (s *Service) GetExperiments(ctx context.Context, request *experimentation.GetExperimentsRequest) (*experimentation.GetExperimentsResponse, error)
  • func (s *Service) GetListView(ctx context.Context, _ *experimentation.GetListViewRequest) (*experimentation.GetListViewResponse, error)
  • func (s *Service) Register(r module.Registrar) error

Constants

const (
	Name = "clutch.module.chaos.experimentation.api"
)

Functions

func New

func New(_ *any.Any, logger *zap.Logger, scope tally.Scope) (module.Module, error)

New instantiates a Service object.

Types

type Service

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

Service contains all dependencies for the API service.

func (*Service) CancelExperimentRun

func (s *Service) CancelExperimentRun(ctx context.Context, req *experimentation.CancelExperimentRunRequest) (*experimentation.CancelExperimentRunResponse, error)

CancelExperimentRun cancels experiment that is currently running or is scheduled to be run in the future.

func (*Service) CreateExperiment

func (s *Service) CreateExperiment(ctx context.Context, req *experimentation.CreateExperimentRequest) (*experimentation.CreateExperimentResponse, error)

CreateExperiments adds experiments to the experiment store.

func (*Service) CreateOrGetExperiment

func (s *Service) CreateOrGetExperiment(ctx context.Context, req *experimentation.CreateOrGetExperimentRequest) (*experimentation.CreateOrGetExperimentResponse, error)

func (*Service) GetExperimentRunDetails

func (s *Service) GetExperimentRunDetails(ctx context.Context, request *experimentation.GetExperimentRunDetailsRequest) (*experimentation.GetExperimentRunDetailsResponse, error)

func (*Service) GetExperiments

func (s *Service) GetExperiments(ctx context.Context, request *experimentation.GetExperimentsRequest) (*experimentation.GetExperimentsResponse, error)

GetExperiments returns all experiments from the experiment store.

func (*Service) GetListView

func (s *Service) GetListView(ctx context.Context, _ *experimentation.GetListViewRequest) (*experimentation.GetListViewResponse, error)

func (*Service) Register

func (s *Service) Register(r module.Registrar) error