blobstore

Documentation

Index

• Variables
• type BucketMetadataResponse
• type Client
  • func NewMetricClient(client Client, metricsClient metrics.Client) Client
  • func NewRetryableClient(client Client, policy backoff.RetryPolicy, isRetryable backoff.IsRetryable) Client

Variables

var (
	// ErrBucketNotExists indicates that requested bucket does not exist
	ErrBucketNotExists = &shared.EntityNotExistsError{Message: "requested bucket does not exist"}
	// ErrBlobNotExists indicates that requested blob does not exist
	ErrBlobNotExists = &shared.EntityNotExistsError{Message: "requested blob does not exist"}
	// ErrBlobSerialization indicates that a failure occurred in serializing blob
	ErrBlobSerialization = &shared.BadRequestError{Message: "failed to serialize blob"}
	// ErrBlobDeserialization indicates that a failure occurred in deserializing blob
	ErrBlobDeserialization = &shared.BadRequestError{Message: "failed to deserialize blob"}
)

Types

type BucketMetadataResponse

type BucketMetadataResponse struct {
	Owner         string
	RetentionDays int
}

BucketMetadataResponse contains information relating to a bucket's configuration

type Client

type Client interface {
	Upload(ctx context.Context, bucket string, key blob.Key, blob *blob.Blob) error
	Download(ctx context.Context, bucket string, key blob.Key) (*blob.Blob, error)
	Exists(ctx context.Context, bucket string, key blob.Key) (bool, error)
	Delete(ctx context.Context, bucket string, key blob.Key) (bool, error)
	ListByPrefix(ctx context.Context, bucket string, prefix string) ([]blob.Key, error)
	BucketMetadata(ctx context.Context, bucket string) (*BucketMetadataResponse, error)
}

Client is used to operate on blobs in a blobstore

func NewMetricClient

func NewMetricClient(client Client, metricsClient metrics.Client) Client

NewMetricClient creates a new instance of Client that emits metrics

func NewRetryableClient

func NewRetryableClient(client Client, policy backoff.RetryPolicy, isRetryable backoff.IsRetryable) Client

NewRetryableClient creates a new instance of Client with retry policy