artifacts

type BaseArtifact struct {
	Name     string
	Expires  tcclient.Time
	Optional bool
}

type ErrorArtifact struct {
	*BaseArtifact
	Path    string
	Message string
	Reason  string
}

type LinkArtifact struct {
	*BaseArtifact
	Artifact    string
	ContentType string
}

type Logger interface {
	// Infof formats and lots a message at the info level
	Infof(format string, a ...any)

	// Errorf formats and lots a message at the error level
	Errorf(format string, a ...any)
}

type ObjectArtifact struct {
	*BaseArtifact
	// Path is the filename of the file containing the data
	// for this artifact.
	Path string
	// ContentType is used in the Content-Type header.
	ContentType string
}

type RedirectArtifact struct {
	*BaseArtifact
	URL         string
	HideURL     bool
	ContentType string
}

type S3Artifact struct {
	*BaseArtifact
	// Path is the filename of the file declared in the task payload.
	Path string
	// ContentPath is the filename of the file containing the data
	// for this artifact. ContentPath may be equal to Path, or,
	// in the case where a temporary file is created, it may be different.
	// ContentPath will always be read from when uploading the artifact.
	ContentPath     string
	ContentEncoding string
	ContentType     string
}

type TaskArtifact interface {

	// RequestObject returns a pointer to a go type containing the data for
	// marshaling into tcqueue.PostArtifactRequest for passing to
	// tcqueue.CreateArtifact.
	//
	// For example, this is a *tcqueue.S3ArtifactRequest for type
	// S3Artifact.
	RequestObject() any

	// ResponseObject returns a pointer to an empty go type for
	// unmarshaling the result of a tcqueue.CreateArtifact API call into.
	//
	// For example, this would be new(tcqueue.RedirectArtifactRequest) for
	// RedirectArtifact.
	ResponseObject() any

	// ProcessResponse is a callback for performing actions after
	// tcqueue.CreateArtifact API is called. response is the object
	// returned by ResponseObject(), but populated with the result of
	// tcqueue.CreateArtifact.
	//
	// For example, ProcessResponse for S3Artifact uploads the artifact to
	// S3, since the tcqueue.CreateArtifact API call only informs the Queue
	// that the artifact exists without uploading it.
	//
	// ProcessResponse can be an empty method if no post
	// tcqueue.CreateArtifact steps are required.
	ProcessResponse(response any, logger Logger, serviceFactory tc.ServiceFactory, config *gwconfig.Config) error

	// FinishArtifact calls queue.FinishArtifact if necessary for the artifact type
	FinishArtifact(response any, queue tc.Queue, taskID, runID, name string) error

	// String returns a string representation of the artifact type
	// with all properties.
	//
	// For example, String for S3Artifact would look something like:
	// "S3 Artifact - Name: artifact, Path: /test/path, Expires: 2006-01-02T15:04:05.000Z,
	// Content Encoding: 'gzip', MIME Type: 'text/plain; charset=utf-8'"
	String() string

	// Base returns a *BaseArtifact which stores the properties common to
	// all implementations
	Base() *BaseArtifact
}