s3

Documentation

Index

• type Client
  • func New(config *Config) (Client, error)
• type Config
  • func FromConfig(s3 *config.S3) *Config
• type Object

Types

type Client

type Client interface {
	GetObject(bucketName, objectName string) (Object, error)
	RemoveObject(bucketName, key string) error
}

Client is a interface to interact with a S3 object store

func New

func New(config *Config) (Client, error)

New creates a new s3 client which is a wrapper of the minio client

type Config

type Config struct {
	Endpoint   string
	SSL        bool
	BucketName string
	AccessKey  string
	SecretKey  string
}

Config holds connection information for a s3 object storage

func FromConfig

func FromConfig(s3 *config.S3) *Config

type Object

type Object interface {
	io.Reader
	Stat() (minio.ObjectInfo, error)
	Close() error
}

Object represents an s3 object that can be retrieved from an object store