artefacts

type ArtefactManager[
	M IManager,
	D ILinkData,
	L ILinks[D],
	C ICollection[D, L],
] struct {
	// contains filtered or unexported fields
}

type DownloadOption func(*DownloadOptions)

type DownloadOptions struct {
	StopOnFirstError      bool
	MaintainTreeStructure bool
	Logger                logs.Loggers
}

type FollowLinkToArtefactManagersPageFunc[D ILinkData, L ILinks[D], C ICollection[D, L]] = func(ctx context.Context, link D) (C, *http.Response, error)

type GetArtefactContentFunc = func(ctx context.Context, job, artefactID string) (*os.File, *http.Response, error)

type GetArtefactManagerFunc[M IManager] = func(ctx context.Context, job, artefact string) (M, *http.Response, error)

type GetArtefactManagersFirstPageFunc[D ILinkData, L ILinks[D], C ICollection[D, L]] = func(ctx context.Context, job string) (C, *http.Response, error)

type IArtefactManager[
	M IManager,
	D ILinkData,
] interface {
	// DownloadJobArtefactFromLink downloads a specific artefact into the output directory from a particular link. The artefact will be placed at the root of the output directory.
	DownloadJobArtefactFromLink(ctx context.Context, jobName string, outputDirectory string, artefactManagerItemLink D) error
	// DownloadJobArtefactFromLinkWithTree downloads a specific artefact into the output directory from a particular link.
	// maintainTreeLocation specifies whether the artefact will be placed in a tree structure or if it will be flat.
	DownloadJobArtefactFromLinkWithTree(ctx context.Context, jobName string, maintainTreeLocation bool, outputDirectory string, artefactManagerItemLink D) error
	// DownloadJobArtefact downloads a specific artefact into the output directory. The artefact will be placed at the root of the output directory.
	DownloadJobArtefact(ctx context.Context, jobName string, outputDirectory string, artefactManager M) error
	// DownloadJobArtefactWithTree downloads a specific artefact into the output directory.
	// maintainTreeLocation specifies whether the artefact will be placed in a tree structure or if it will be flat.
	DownloadJobArtefactWithTree(ctx context.Context, jobName string, maintainTreeLocation bool, outputDirectory string, artefactManager M) error
	// ListJobArtefacts lists all artefact managers associated with a particular job.
	ListJobArtefacts(ctx context.Context, jobName string) (pagination.IPaginatorAndPageFetcher, error)
	// DownloadAllJobArtefacts downloads all the artefacts produced for a particular job and puts them in an output directory as a flat list.
	DownloadAllJobArtefacts(ctx context.Context, jobName string, outputDirectory string) error
	// DownloadAllJobArtefactsWithTree downloads all the artefacts produced for a particular job and puts them in an output directory.
	// maintainTreeStructure specifies whether to keep the tree structure of the artefacts or not in the output directory.
	DownloadAllJobArtefactsWithTree(ctx context.Context, jobName string, maintainTreeStructure bool, outputDirectory string) error
	// DownloadAllJobArtefactsWithOptions downloads all the artefacts produced for a particular job and puts them in an output directory, specify some download option.
	DownloadAllJobArtefactsWithOptions(ctx context.Context, jobName string, outputDirectory string, opts ...DownloadOption) (err error)
}

type ICollection[D ILinkData, L ILinks[D]] interface {
	comparable
	pagination.IStaticPage
	GetLinksOk() (L, bool)
}

type ILinkData interface {
	comparable
	GetName() string
	GetHref() string
}

type ILinks[D ILinkData] interface {
	comparable
	GetNextP() D
	HasNext() bool
}

type IManager interface {
	comparable
	GetName() string
	GetTitle() string
	HasTitle() bool
	GetHashOk() (*string, bool)
	GetSizeOk() (*int64, bool)
	GetExtraMetadata() map[string]string
	HasExtraMetadata() bool
}