s3

Documentation

Index

• Constants
• type Client
  • func NewClient(endpoint, ak, sk string, insecure, forcedPathStyle bool) (*Client, error)
  • func (c *Client) CopyObject(bucketName, oldKey, newKey string) error
  • func (c *Client) DeleteObjects(bucketName string, keys []string) error
  • func (c *Client) Download(bucketName, objectKey, dest string) error
  • func (c *Client) DownloadWithOption(bucketName, objectKey, dest string, option *DownloadOption) error
  • func (c *Client) GetFile(bucketName, objectKey string, option *DownloadOption) (*s3.GetObjectOutput, error)
  • func (c *Client) ListFiles(bucketName, prefix string, recursive bool) ([]string, error)
  • func (c *Client) RemoveFiles(bucketName string, prefixList []string)
  • func (c *Client) Upload(bucketName, src string, objectKey string) error
  • func (c *Client) UploadDir(bucketName, srcdir string, s3dir string) error
  • func (c *Client) ValidateBucket(bucketName string) error
• type DownloadOption

Constants

const (
	DefaultRegion = "ap-shanghai"
)

Types

type Client

type Client struct {
	*s3.S3
}

func NewClient

func NewClient(endpoint, ak, sk string, insecure, forcedPathStyle bool) (*Client, error)

func (*Client) CopyObject

func (c *Client) CopyObject(bucketName, oldKey, newKey string) error

CopyObject copies an object to a new place in the same bucket.

func (*Client) DeleteObjects

func (c *Client) DeleteObjects(bucketName string, keys []string) error

DeleteObjects deletes all the objects listed in keys.

func (*Client) Download

func (c *Client) Download(bucketName, objectKey, dest string) error

Download the file to object storage

func (*Client) DownloadWithOption

func (c *Client) DownloadWithOption(bucketName, objectKey, dest string, option *DownloadOption) error

func (*Client) GetFile

func (c *Client) GetFile(bucketName, objectKey string, option *DownloadOption) (*s3.GetObjectOutput, error)

func (*Client) ListFiles

func (c *Client) ListFiles(bucketName, prefix string, recursive bool) ([]string, error)

ListFiles with given prefix

func (*Client) RemoveFiles

func (c *Client) RemoveFiles(bucketName string, prefixList []string)

RemoveFiles removes the files with a specific list of prefixes and delete ALL of them for NOW, if an error is encountered, nothing will happen except for a line of error log.

func (*Client) Upload

func (c *Client) Upload(bucketName, src string, objectKey string) error

Upload uploads a file from src to the bucket with the specified objectKey

func (*Client) UploadDir

func (c *Client) UploadDir(bucketName, srcdir string, s3dir string) error

Upload upload all files in a directory to a S3 path recursively

func (*Client) ValidateBucket

func (c *Client) ValidateBucket(bucketName string) error

Validate the existence of bucket

type DownloadOption

type DownloadOption struct {
	IgnoreNotExistError bool
	RetryNum            int
}