gcsx

Documentation

Overview

Package gcsx contains utilities for working with Google Cloud Storage (GCS).

Index

• func BucketExists(client *storage.Service, bucket string) (bool, error)
• func CreateBucket(client *storage.Service, project, bucket string) error
• func Join(object string, elm string) string
• func MakeObject(bucket, path string) string
• func NewClient(ctx context.Context, scope string) (*storage.Service, error)
• func NewUnauthenticatedClient(ctx context.Context) (*storage.Service, error)
• func ParseObject(object string) (bucket, path string, err error)
• func ReadObject(client *storage.Service, bucket, object string) ([]byte, error)
• func Upload(client *storage.Service, project, bucket, object string, r io.Reader) (string, error)
• func WriteObject(client *storage.Service, bucket, object string, r io.Reader) error

Functions

func BucketExists

func BucketExists(client *storage.Service, bucket string) (bool, error)

BucketExists returns true iff the given bucket exists.

func CreateBucket

func CreateBucket(client *storage.Service, project, bucket string) error

CreateBucket creates a bucket in GCS.

func Join

func Join(object string, elm string) string

Join joins a GCS path with an element. Preserves the gs:// prefix.

func MakeObject

func MakeObject(bucket, path string) string

MakeObject creates a object location from bucket and path. For example, MakeObject("foo", "bar/baz") returns "gs://foo/bar/baz". The bucket must be non-empty.

func NewClient

func NewClient(ctx context.Context, scope string) (*storage.Service, error)

NewClient creates a new GCS client with default application credentials.

func NewUnauthenticatedClient

func NewUnauthenticatedClient(ctx context.Context) (*storage.Service, error)

NewUnauthenticatedClient creates a new GCS client without authentication.

func ParseObject

func ParseObject(object string) (bucket, path string, err error)

ParseObject deconstructs a GCS object name into (bucket, name).

func ReadObject

func ReadObject(client *storage.Service, bucket, object string) ([]byte, error)

ReadObject reads the content of the given object in full.

func Upload

func Upload(client *storage.Service, project, bucket, object string, r io.Reader) (string, error)

Upload writes the given content to GCS. If the specified bucket does not exist, it is created first. Returns the full path of the object.

func WriteObject

func WriteObject(client *storage.Service, bucket, object string, r io.Reader) error

WriteObject writes the given content to the specified object. If the object already exist, it is overwritten.