backend

type Backend interface {
	Connect(context contextpkg.Context) error
	Release(context contextpkg.Context) error
	String() string

	// Owns and may change the contents of the template argument.
	// Ignores template DeploymentIDs.
	// Can return BadArgumentError, NotDoneError.
	SetTemplate(context contextpkg.Context, template *Template) error

	// Can return BadArgumentError, NotFoundError.
	GetTemplate(context contextpkg.Context, templateId string) (*Template, error)

	// Does *not* delete associated deployments, but removes associations.
	// Can return BadArgumentError, NotFoundError, NotDoneError.
	DeleteTemplate(context contextpkg.Context, templateId string) error

	// Can return BadArgumentError.
	ListTemplates(context contextpkg.Context, selectTemplates SelectTemplates, window Window) (util.Results[TemplateInfo], error)

	// Does *not* delete associated deployments, but removes associations.
	// Can return BadArgumentError, NotDoneError.
	PurgeTemplates(context contextpkg.Context, selectTemplates SelectTemplates) error

	// Owns and may change the contents of the site argument.
	// Ignores site DeploymentIDs.
	// Can return BadArgumentError, NotDoneError.
	SetSite(context contextpkg.Context, site *Site) error

	// Can return BadArgumentError, NotFoundError.
	GetSite(context contextpkg.Context, siteId string) (*Site, error)

	// Does *not* delete associated deployments, but removes association.
	// Can return BadArgumentError, NotFoundError, NotDoneError.
	DeleteSite(context contextpkg.Context, siteId string) error

	// Can return BadArgumentError.
	ListSites(context contextpkg.Context, selectSites SelectSites, window Window) (util.Results[SiteInfo], error)

	// Does *not* delete associated deployments, but removes association.
	// Can return BadArgumentError, NotDoneError.
	PurgeSites(context contextpkg.Context, selectSites SelectSites) error

	// Owns and may change the contents of the deployment argument.
	// Can return BadArgumentError, NotDoneError.
	CreateDeployment(context contextpkg.Context, deployment *Deployment) error

	// Can return BadArgumentError, NotFoundError.
	GetDeployment(context contextpkg.Context, deploymentId string) (*Deployment, error)

	// Does *not* delete child deployments, but orphans them.
	// Can return BadArgumentError, NotFoundError, NotDoneError.
	DeleteDeployment(context contextpkg.Context, deploymentId string) error

	// Can return BadArgumentError.
	ListDeployments(context contextpkg.Context, selectDeployments SelectDeployments, window Window) (util.Results[DeploymentInfo], error)

	// Does *not* delete child deployments, but orphans them.
	// Can return BadArgumentError, NotDoneError.
	PurgeDeployments(context contextpkg.Context, selectDeployments SelectDeployments) error

	// Can return BadArgumentError, NotFoundError, NotDoneError, BusyError.
	StartDeploymentModification(context contextpkg.Context, deploymentId string) (string, *Deployment, error)

	// Owns and may change the contents of the package argument.
	// May change TemplateID, SiteID, Prepared, Approved.
	// Does *not* modify Metadata, even if modified package indicate a change.
	// If validation is not nil, should validate the modification. If the deployment is prepared, it should be complete validation.
	// Can return BadArgumentError, NotFoundError, NotDoneError, TimeoutError.
	EndDeploymentModification(context contextpkg.Context, modificationToken string, package_ tkoutil.Package, validation *validationpkg.Validation) (string, error)

	// Can return BadArgumentError, NotFoundError, NotDoneError.
	CancelDeploymentModification(context contextpkg.Context, modificationToken string) error

	// Owns and may change the contents of the plugin argument.
	// Can return BadArgumentError, NotDoneError.
	SetPlugin(context contextpkg.Context, plugin *Plugin) error

	// Can return BadArgumentError, NotFoundError.
	GetPlugin(context contextpkg.Context, pluginId PluginID) (*Plugin, error)

	// Can return BadArgumentError, NotFoundError, NotDoneError.
	DeletePlugin(context contextpkg.Context, pluginId PluginID) error

	// Can return BadArgumentError.
	ListPlugins(context contextpkg.Context, selectPlugins SelectPlugins, window Window) (util.Results[Plugin], error)

	// Can return BadArgumentError, NotDoneError.
	PurgePlugins(context contextpkg.Context, selectPlugins SelectPlugins) error
}

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

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

type Deployment struct {
	DeploymentInfo
	Package util.Package
}

type DeploymentInfo struct {
	DeploymentID       string
	ParentDeploymentID string
	TemplateID         string
	SiteID             string
	Metadata           map[string]string
	Created            time.Time // millisecond precision
	Updated            time.Time // millisecond precision
	Prepared           bool
	Approved           bool
}

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

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

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

type Plugin struct {
	PluginID
	Executor   string
	Arguments  []string
	Properties map[string]string
	Triggers   []util.GVK
}

type PluginID struct {
	Type string
	Name string
}

type SelectDeployments struct {
	ParentDeploymentID       *string
	TemplateIDPatterns       []string
	TemplateMetadataPatterns map[string]string
	SiteIDPatterns           []string
	SiteMetadataPatterns     map[string]string
	MetadataPatterns         map[string]string
	Prepared                 *bool
	Approved                 *bool
}

type SelectPlugins struct {
	Type         *string
	NamePatterns []string
	Executor     *string
	Trigger      *util.GVK
}

type SelectSites struct {
	SiteIDPatterns     []string
	TemplateIDPatterns []string
	MetadataPatterns   map[string]string
}

type SelectTemplates struct {
	TemplateIDPatterns []string
	MetadataPatterns   map[string]string
}

type Site struct {
	SiteInfo
	Package util.Package
}

type SiteInfo struct {
	SiteID        string
	TemplateID    string
	Metadata      map[string]string
	Updated       time.Time // millisecond precision
	DeploymentIDs []string
}

type Template struct {
	TemplateInfo
	Package util.Package
}

type TemplateInfo struct {
	TemplateID    string
	Metadata      map[string]string
	Updated       time.Time // millisecond precision
	DeploymentIDs []string
}

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

type Window struct {
	Offset   uint
	MaxCount int // <0 for maximum number of results
}