gcs

Documentation

Overview

Package gcs provides the Google Cloud Storage disk implementation.

Index

• Constants
• func NewAutoWire(ctx context.Context, cfg map[string]interface{}) (godrive.Disk, error)
• func Register(cfg *godrive.AutoWireConfig)
• type Config
• type Disk
  • func NewDisk(client *gcs.Client, bucket string, options ...Option) *Disk
  • func (d *Disk) Delete(ctx context.Context, path string) error
  • func (d *Disk) Get(ctx context.Context, path string) ([]byte, error)
  • func (d *Disk) GetURL(_ context.Context, path string) (string, error)
  • func (d *Disk) Put(ctx context.Context, path string, b []byte) error
  • func (d *Disk) PutReader(ctx context.Context, path string, r io.Reader) error
• type InvalidConfigValueError
  • func (err InvalidConfigValueError) Error() string
• type Option
  • func Public(public bool) Option
  • func URLTemplate(tpl string) Option

Constants

const (
	// DefaultURLTemplate is the default URL template to use for (*Disk).GetURL().
	DefaultURLTemplate = "https://storage.googleapis.com/{{ .Bucket }}/{{ .Path }}"
)

const (
	// Provider is the provider name for Google Cloud Storage.
	Provider = "gcs"
)

Functions

func NewAutoWire

func NewAutoWire(ctx context.Context, cfg map[string]interface{}) (godrive.Disk, error)

NewAutoWire creates a new Google Cloud Storage disk from an autowire configuration.

func Register

func Register(cfg *godrive.AutoWireConfig)

Register registeres Google Cloud Storage as a provider for the disk autowire.

Types

type Config

type Config struct {
	Bucket      string
	Public      bool
	URLTemplate string
}

Config is the disk configuration.

type Disk

type Disk struct {
	Client *gcs.Client
	Config Config
}

Disk is the Google Cloud Storage disk.

func NewDisk

func NewDisk(client *gcs.Client, bucket string, options ...Option) *Disk

NewDisk creates a new Google Cloud Storage disk.

func (*Disk) Delete

func (d *Disk) Delete(ctx context.Context, path string) error

Delete deletes the file at the given path.

func (*Disk) Get

func (d *Disk) Get(ctx context.Context, path string) ([]byte, error)

Get retrieves the file at the given path.

func (*Disk) GetURL

func (d *Disk) GetURL(_ context.Context, path string) (string, error)

GetURL returns the public URL for the file at the given path.

func (*Disk) Put

func (d *Disk) Put(ctx context.Context, path string, b []byte) error

Put writes b to the file at the given path.

func (*Disk) PutReader

func (d *Disk) PutReader(ctx context.Context, path string, r io.Reader) error

PutReader writes r to the file at the given path.

type InvalidConfigValueError

type InvalidConfigValueError struct {
	Key     string
	Details string
}

InvalidConfigValueError means the autowire configuration has an invalid config value.

func (InvalidConfigValueError) Error

func (err InvalidConfigValueError) Error() string

type Option

type Option func(*Config)

Option is a disk configuration option.

func Public

func Public(public bool) Option

Public configures the disk to make all uploaded files publicly accessible. Note that this option will not work and storing files will return an error if "uniform bucket-level access" is configured on the bucket, because individual ACL for specific objects is not available for those buckets.

func URLTemplate

func URLTemplate(tpl string) Option

URLTemplate overrides the default template for public URLs.