api

Documentation

Index

• type Api
  • func New(moduleHandler handler.ModuleHandler, ...) *Api
  • func (a *Api) AddModule(ctx context.Context, id, version string) (string, error)
  • func (a *Api) CancelJob(_ context.Context, id string) error
  • func (a *Api) CancelPendingModuleUpdate(ctx context.Context, id string) error
  • func (a *Api) CheckModuleUpdates(ctx context.Context) (string, error)
  • func (a *Api) CreateDeployment(ctx context.Context, id string, depInput model.DepInput, ...) (string, error)
  • func (a *Api) DeleteDeployment(ctx context.Context, id string, orphans bool) error
  • func (a *Api) DeleteModule(ctx context.Context, id string, orphans, force bool) error
  • func (a *Api) DisableDeployment(_ context.Context, id string, dependencies bool) (string, error)
  • func (a *Api) EnableDeployment(ctx context.Context, id string) error
  • func (a *Api) GetDeployment(ctx context.Context, id string) (model.Deployment, error)
  • func (a *Api) GetDeploymentHealth(ctx context.Context, dID string) (model.DepHealthInfo, error)
  • func (a *Api) GetDeploymentUpdateTemplate(ctx context.Context, id string) (model.DepUpdateTemplate, error)
  • func (a *Api) GetDeployments(ctx context.Context, filter model.DepFilter) ([]model.DepBase, error)
  • func (a *Api) GetDeploymentsHealth(ctx context.Context) (map[string]model.DepHealthInfo, error)
  • func (a *Api) GetJob(_ context.Context, id string) (model.Job, error)
  • func (a *Api) GetJobs(_ context.Context, filter model.JobFilter) ([]model.Job, error)
  • func (a *Api) GetModule(ctx context.Context, id string) (model.Module, error)
  • func (a *Api) GetModuleDeployTemplate(ctx context.Context, id string) (model.ModDeployTemplate, error)
  • func (a *Api) GetModuleUpdate(ctx context.Context, id string) (model.ModUpdate, error)
  • func (a *Api) GetModuleUpdateTemplate(ctx context.Context, id string) (model.ModUpdateTemplate, error)
  • func (a *Api) GetModuleUpdates(ctx context.Context) (map[string]model.ModUpdate, error)
  • func (a *Api) GetModules(ctx context.Context, filter model.ModFilter) ([]model.ModuleMeta, error)
  • func (a *Api) PrepareModuleUpdate(ctx context.Context, id, version string) (string, error)
  • func (a *Api) StartDeployments() error
  • func (a *Api) UpdateDeployment(ctx context.Context, dID string, depInput model.DepInput) (string, error)
  • func (a *Api) UpdateModule(ctx context.Context, id string, depInput model.DepInput, ...) (string, error)

Types

type Api

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

func New

func New(moduleHandler handler.ModuleHandler, moduleStagingHandler handler.ModStagingHandler, moduleUpdateHandler handler.ModUpdateHandler, deploymentHandler handler.DeploymentHandler, depHealthHandler handler.DepHealthHandler, jobHandler handler.JobHandler) *Api

func (*Api) AddModule

func (a *Api) AddModule(ctx context.Context, id, version string) (string, error)

func (*Api) CancelJob

func (a *Api) CancelJob(_ context.Context, id string) error

func (*Api) CancelPendingModuleUpdate

func (a *Api) CancelPendingModuleUpdate(ctx context.Context, id string) error

func (*Api) CheckModuleUpdates

func (a *Api) CheckModuleUpdates(ctx context.Context) (string, error)

func (*Api) CreateDeployment

func (a *Api) CreateDeployment(ctx context.Context, id string, depInput model.DepInput, dependencies map[string]model.DepInput) (string, error)

func (*Api) DeleteDeployment

func (a *Api) DeleteDeployment(ctx context.Context, id string, orphans bool) error

func (*Api) DeleteModule

func (a *Api) DeleteModule(ctx context.Context, id string, orphans, force bool) error

func (*Api) DisableDeployment

func (a *Api) DisableDeployment(_ context.Context, id string, dependencies bool) (string, error)

func (*Api) EnableDeployment

func (a *Api) EnableDeployment(ctx context.Context, id string) error

func (*Api) GetDeployment

func (a *Api) GetDeployment(ctx context.Context, id string) (model.Deployment, error)

func (*Api) GetDeploymentHealth

func (a *Api) GetDeploymentHealth(ctx context.Context, dID string) (model.DepHealthInfo, error)

func (*Api) GetDeploymentUpdateTemplate

func (a *Api) GetDeploymentUpdateTemplate(ctx context.Context, id string) (model.DepUpdateTemplate, error)

func (*Api) GetDeployments

func (a *Api) GetDeployments(ctx context.Context, filter model.DepFilter) ([]model.DepBase, error)

func (*Api) GetDeploymentsHealth

func (a *Api) GetDeploymentsHealth(ctx context.Context) (map[string]model.DepHealthInfo, error)

func (*Api) GetJob

func (a *Api) GetJob(_ context.Context, id string) (model.Job, error)

func (*Api) GetJobs

func (a *Api) GetJobs(_ context.Context, filter model.JobFilter) ([]model.Job, error)

func (*Api) GetModule

func (a *Api) GetModule(ctx context.Context, id string) (model.Module, error)

func (*Api) GetModuleDeployTemplate

func (a *Api) GetModuleDeployTemplate(ctx context.Context, id string) (model.ModDeployTemplate, error)

func (*Api) GetModuleUpdate

func (a *Api) GetModuleUpdate(ctx context.Context, id string) (model.ModUpdate, error)

func (*Api) GetModuleUpdateTemplate

func (a *Api) GetModuleUpdateTemplate(ctx context.Context, id string) (model.ModUpdateTemplate, error)

func (*Api) GetModuleUpdates

func (a *Api) GetModuleUpdates(ctx context.Context) (map[string]model.ModUpdate, error)

func (*Api) GetModules

func (a *Api) GetModules(ctx context.Context, filter model.ModFilter) ([]model.ModuleMeta, error)

func (*Api) PrepareModuleUpdate

func (a *Api) PrepareModuleUpdate(ctx context.Context, id, version string) (string, error)

func (*Api) StartDeployments

func (a *Api) StartDeployments() error

func (*Api) UpdateDeployment

func (a *Api) UpdateDeployment(ctx context.Context, dID string, depInput model.DepInput) (string, error)

func (*Api) UpdateModule

func (a *Api) UpdateModule(ctx context.Context, id string, depInput model.DepInput, dependencies map[string]model.DepInput, orphans bool) (string, error)