s3

Documentation

Index

• func ParsePublishedKey(key string, executionID string, job model.Job, archive bool) string
• type Params
  • func DecodeSpec(spec model.PublisherSpec) (Params, error)
  • func (c Params) ToMap() map[string]interface{}
  • func (c Params) Validate() error
• type Publisher
  • func NewPublisher(params PublisherParams) *Publisher
  • func (publisher *Publisher) IsInstalled(_ context.Context) (bool, error)
  • func (publisher *Publisher) PublishResult(ctx context.Context, executionID string, j model.Job, resultPath string) (model.StorageSpec, error)
  • func (publisher *Publisher) ValidateJob(_ context.Context, j model.Job) error
• type PublisherParams

Functions

func ParsePublishedKey

func ParsePublishedKey(key string, executionID string, job model.Job, archive bool) string

Types

type Params

type Params struct {
	Bucket   string `json:"Bucket"`
	Key      string `json:"Key"`
	Endpoint string `json:"Endpoint"`
	Region   string `json:"Region"`
	Compress bool   `json:"Compress"`
}

func DecodeSpec

func DecodeSpec(spec model.PublisherSpec) (Params, error)

func (Params) ToMap

func (c Params) ToMap() map[string]interface{}

func (Params) Validate

func (c Params) Validate() error

type Publisher

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

func NewPublisher

func NewPublisher(params PublisherParams) *Publisher

func (*Publisher) IsInstalled

func (publisher *Publisher) IsInstalled(_ context.Context) (bool, error)

IsInstalled returns true if the S3 client is installed.

func (*Publisher) PublishResult

func (publisher *Publisher) PublishResult(
	ctx context.Context,
	executionID string,
	j model.Job,
	resultPath string,
) (model.StorageSpec, error)

func (*Publisher) ValidateJob

func (publisher *Publisher) ValidateJob(_ context.Context, j model.Job) error

ValidateJob validates the job spec and returns an error if the job is invalid.

type PublisherParams

type PublisherParams struct {
	LocalDir       string
	ClientProvider *s3helper.ClientProvider
}