s3

Documentation

Index

• Constants
• type Conf
  • func (c *Conf) Cast() error
• type Credentials
• type S3
  • func New(opts Conf) (*S3, error)
  • func (s *S3) CheckFile(name string) error
  • func (s *S3) Delete(name string) error
  • func (s *S3) Files(suffix string) ([][]byte, error)
  • func (s *S3) List(prefix string) ([]string, error)
  • func (s *S3) Save(name string, data io.Reader) error
  • func (s *S3) SourceReader(name string) (io.ReadCloser, error)
• type S3Provider

Constants

const (
	// GCSEndpointURL is the endpoint url for Google Clound Strage service
	GCSEndpointURL = "storage.googleapis.com"
)

Types

type Conf

type Conf struct {
	Provider    S3Provider  `bson:"provider,omitempty" json:"provider,omitempty" yaml:"provider,omitempty"`
	Region      string      `bson:"region" json:"region" yaml:"region"`
	EndpointURL string      `bson:"endpointUrl,omitempty" json:"endpointUrl" yaml:"endpointUrl,omitempty"`
	Bucket      string      `bson:"bucket" json:"bucket" yaml:"bucket"`
	Prefix      string      `bson:"prefix,omitempty" json:"prefix,omitempty" yaml:"prefix,omitempty"`
	Credentials Credentials `bson:"credentials" json:"credentials,omitempty" yaml:"credentials"`
}

func (*Conf) Cast

func (c *Conf) Cast() error

type Credentials

type Credentials struct {
	AccessKeyID     string `bson:"access-key-id" json:"access-key-id,omitempty" yaml:"access-key-id,omitempty"`
	SecretAccessKey string `bson:"secret-access-key" json:"secret-access-key,omitempty" yaml:"secret-access-key,omitempty"`
	Vault           struct {
		Server string `bson:"server" json:"server,omitempty" yaml:"server"`
		Secret string `bson:"secret" json:"secret,omitempty" yaml:"secret"`
		Token  string `bson:"token" json:"token,omitempty" yaml:"token"`
	} `bson:"vault" json:"vault" yaml:"vault,omitempty"`
}

type S3

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

func New

func New(opts Conf) (*S3, error)

func (*S3) CheckFile

func (s *S3) CheckFile(name string) error

func (*S3) Delete

func (s *S3) Delete(name string) error

Delete deletes given file. It returns storage.ErrNotExist if a file isn't exists

func (*S3) Files

func (s *S3) Files(suffix string) ([][]byte, error)

func (*S3) List

func (s *S3) List(prefix string) ([]string, error)

func (*S3) Save

func (s *S3) Save(name string, data io.Reader) error

func (*S3) SourceReader

func (s *S3) SourceReader(name string) (io.ReadCloser, error)

type S3Provider

type S3Provider string

const (
	S3ProviderUndef S3Provider = ""
	S3ProviderAWS   S3Provider = "aws"
	S3ProviderGCS   S3Provider = "gcs"
)