gcsifaces

Documentation

Overview

Package gcsifaces provides interfaces for Google Cloud Storage.

Index

• type StorageBucket
• type StorageClient
• type StorageObject
• type StorageWriter

Types

type StorageBucket

type StorageBucket interface {
	// Object returns a StorageObject for a key.
	Object(key string) StorageObject
}

StorageBucket represents a GCS bucket.

type StorageClient

type StorageClient interface {
	// Bucket gets a StorageBucket.
	Bucket(name string) StorageBucket
	// FindDefaultCredentials finds default Google credentials.
	FindDefaultCredentials(ctx context.Context, scope string) (*google.Credentials, error)
	// JWTConfigFromJSON gets JWT config from a JSON document.
	JWTConfigFromJSON(keyJSON []byte) (*jwt.Config, error)
	// SignedURL returns a signed URL for the specified object.
	SignedURL(bucket, name string, opts *storage.SignedURLOptions) (string, error)
}

StorageClient represents a GCS client.

type StorageObject

type StorageObject interface {
	// NewWriter returns a new StorageWriter.
	NewWriter(ctx context.Context) StorageWriter
}

StorageObject represents a GCS object.

type StorageWriter

type StorageWriter interface {
	io.WriteCloser

	// SetACL sets a pre-defined ACL.
	SetACL(acl string)
}

StorageWriter represents a GCS writer.