cos

package module
v3.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 24, 2021 License: Apache-2.0 Imports: 17 Imported by: 1

README

Services Test Cos

cos

COS(Cloud Object Storage) service support for go-storage.

Install

go get go.beyondstorage.io/services/cos/v3

Usage

import (
	"log"

	_ "go.beyondstorage.io/services/cos/v3"
	"go.beyondstorage.io/v5/services"
)

func main() {
	store, err := services.NewStoragerFromString("cos://bucket_name/path/to/workdir?credential=hmac:<account_name>:<account_key>")
	if err != nil {
		log.Fatal(err)
	}
	
	// Write data from io.Reader into hello.txt
	n, err := store.Write("hello.txt", r, length)
}

Documentation

Overview

Package cos provided support for Tencent Cloud's Cloud Object Storage (https://intl.cloud.tencent.com/product/cos)

Code generated by go generate via cmd/definitions; DO NOT EDIT.

Index

Constants

View Source 
const (
	StorageClassStandard   = "STANDARD"
	StorageClassStandardIA = "STANDARD_IA"
	StorageClassArchive    = "ARCHIVE"
)

All available storage classes are listed here.

View Source 
const (
	ServerSideEncryptionAes256 = "AES256"
	ServerSideEncryptionCosKms = "cos/kms"
)

All available server side algorithm are listed here.

View Source 
const Type = "cos"

Type is the type for cos

Variables

View Source 
var (
	// ErrServerSideEncryptionCustomerKeyInvalid will be returned while server-side encryption customer key is invalid.
	ErrServerSideEncryptionCustomerKeyInvalid = services.NewErrorCode("invalid server-side encryption customer key")
)

Functions

func New 

func New(pairs ...typ.Pair) (_ typ.Servicer, _ typ.Storager, err error)

New will create both Servicer and Storager.

func NewServicer 

func NewServicer(pairs ...typ.Pair) (typ.Servicer, error)

NewServicer will create Servicer only.

func NewStorager 

func NewStorager(pairs ...typ.Pair) (typ.Storager, error)

NewStorager will create Storager only.

func WithDefaultServicePairs 

func WithDefaultServicePairs(v DefaultServicePairs) Pair

WithDefaultServicePairs will apply default_service_pairs value to Options.

func WithDefaultStoragePairs 

func WithDefaultStoragePairs(v DefaultStoragePairs) Pair

WithDefaultStoragePairs will apply default_storage_pairs value to Options.

func WithEnableVirtualDir 

func WithEnableVirtualDir() Pair

WithEnableVirtualDir will apply enable_virtual_dir value to Options.

virtual_dir feature is designed for a service that doesn't have native dir support but wants to provide simulated operations.

- If this feature is disabled (the default behavior), the service will behave like it doesn't have any dir support. - If this feature is enabled, the service will support simulated dir behavior in create_dir, create, list, delete, and so on.

This feature was introduced in GSP-109.

func WithServerSideEncryption 

func WithServerSideEncryption(v string) Pair

WithServerSideEncryption will apply server_side_encryption value to Options.

the server-side encryption algorithm used when storing this object. It can be `AES-256` for SSE-COS, and `cos/kms` for SSE-KMS.

func WithServerSideEncryptionContext 

func WithServerSideEncryptionContext(v string) Pair

WithServerSideEncryptionContext will apply server_side_encryption_context value to Options.

specifies the COS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

func WithServerSideEncryptionCosKmsKeyID 

func WithServerSideEncryptionCosKmsKeyID(v string) Pair

WithServerSideEncryptionCosKmsKeyID will apply server_side_encryption_cos_kms_key_id value to Options.

specifies the COS KMS key ID to use for object encryption.

func WithServerSideEncryptionCustomerAlgorithm 

func WithServerSideEncryptionCustomerAlgorithm(v string) Pair

WithServerSideEncryptionCustomerAlgorithm will apply server_side_encryption_customer_algorithm value to Options.

specifies the algorithm to use to when encrypting the object. Now only `AES256` is supported.

func WithServerSideEncryptionCustomerKey 

func WithServerSideEncryptionCustomerKey(v []byte) Pair

WithServerSideEncryptionCustomerKey will apply server_side_encryption_customer_key value to Options.

specifies the customer-provided encryption key to encrypt/decrypt the source object. It must be a 32-byte AES-256 key.

func WithServiceFeatures 

func WithServiceFeatures(v ServiceFeatures) Pair

WithServiceFeatures will apply service_features value to Options.

func WithStorageClass 

func WithStorageClass(v string) Pair

WithStorageClass will apply storage_class value to Options.

func WithStorageFeatures 

func WithStorageFeatures(v StorageFeatures) Pair

WithStorageFeatures will apply storage_features value to Options.

Types

type DefaultServicePairs 

type DefaultServicePairs struct {
	Create []Pair
	Delete []Pair
	Get    []Pair
	List   []Pair
}

DefaultServicePairs is default pairs for specific action

type DefaultStoragePairs 

type DefaultStoragePairs struct {
	CompleteMultipart []Pair
	Create            []Pair
	CreateDir         []Pair
	CreateMultipart   []Pair
	Delete            []Pair
	List              []Pair
	ListMultipart     []Pair
	Metadata          []Pair
	Read              []Pair
	Stat              []Pair
	Write             []Pair
	WriteMultipart    []Pair
}

DefaultStoragePairs is default pairs for specific action

type ObjectSystemMetadata 

type ObjectSystemMetadata struct {
	ServerSideEncryption                  string
	ServerSideEncryptionCosKmsKeyID       string
	ServerSideEncryptionCustomerAlgorithm string
	ServerSideEncryptionCustomerKeyMd5    string
	StorageClass                          string
}

ObjectSystemMetadata stores system metadata for object.

func GetObjectSystemMetadata 

func GetObjectSystemMetadata(o *Object) ObjectSystemMetadata

GetObjectSystemMetadata will get ObjectSystemMetadata from Object.

- This function should not be called by service implementer. - The returning ObjectServiceMetadata is read only and should not be modified.

type Service 

type Service struct {
	typ.UnimplementedServicer
	// contains filtered or unexported fields
}

Service is the Tencent oss *Service config.

func (*Service) Create 

func (s *Service) Create(name string, pairs ...Pair) (store Storager, err error)

func (*Service) CreateWithContext 

func (s *Service) CreateWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)

func (*Service) Delete 

func (s *Service) Delete(name string, pairs ...Pair) (err error)

func (*Service) DeleteWithContext 

func (s *Service) DeleteWithContext(ctx context.Context, name string, pairs ...Pair) (err error)

func (*Service) Get 

func (s *Service) Get(name string, pairs ...Pair) (store Storager, err error)

func (*Service) GetWithContext 

func (s *Service) GetWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)

func (*Service) List 

func (s *Service) List(pairs ...Pair) (sti *StoragerIterator, err error)

func (*Service) ListWithContext 

func (s *Service) ListWithContext(ctx context.Context, pairs ...Pair) (sti *StoragerIterator, err error)

func (*Service) String 

func (s *Service) String() string

String implements Servicer.String

type ServiceFeatures 

type ServiceFeatures struct {
}

type Storage 

type Storage struct {
	typ.UnimplementedStorager
	typ.UnimplementedDirer
	typ.UnimplementedMultiparter
	// contains filtered or unexported fields
}

Storage is the cos object storage service.

func (*Storage) CompleteMultipart 

func (s *Storage) CompleteMultipart(o *Object, parts []*Part, pairs ...Pair) (err error)

func (*Storage) CompleteMultipartWithContext 

func (s *Storage) CompleteMultipartWithContext(ctx context.Context, o *Object, parts []*Part, pairs ...Pair) (err error)

func (*Storage) Create 

func (s *Storage) Create(path string, pairs ...Pair) (o *Object)

func (*Storage) CreateDir 

func (s *Storage) CreateDir(path string, pairs ...Pair) (o *Object, err error)

func (*Storage) CreateDirWithContext 

func (s *Storage) CreateDirWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)

func (*Storage) CreateMultipart 

func (s *Storage) CreateMultipart(path string, pairs ...Pair) (o *Object, err error)

func (*Storage) CreateMultipartWithContext 

func (s *Storage) CreateMultipartWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)

func (*Storage) Delete 

func (s *Storage) Delete(path string, pairs ...Pair) (err error)

func (*Storage) DeleteWithContext 

func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)

func (*Storage) List 

func (s *Storage) List(path string, pairs ...Pair) (oi *ObjectIterator, err error)

func (*Storage) ListMultipart 

func (s *Storage) ListMultipart(o *Object, pairs ...Pair) (pi *PartIterator, err error)

func (*Storage) ListMultipartWithContext 

func (s *Storage) ListMultipartWithContext(ctx context.Context, o *Object, pairs ...Pair) (pi *PartIterator, err error)

func (*Storage) ListWithContext 

func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...Pair) (oi *ObjectIterator, err error)

func (*Storage) Metadata 

func (s *Storage) Metadata(pairs ...Pair) (meta *StorageMeta)

func (*Storage) Read 

func (s *Storage) Read(path string, w io.Writer, pairs ...Pair) (n int64, err error)

func (*Storage) ReadWithContext 

func (s *Storage) ReadWithContext(ctx context.Context, path string, w io.Writer, pairs ...Pair) (n int64, err error)

func (*Storage) Stat 

func (s *Storage) Stat(path string, pairs ...Pair) (o *Object, err error)

func (*Storage) StatWithContext 

func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)

func (*Storage) String 

func (s *Storage) String() string

String implements Storager.String

func (*Storage) Write 

func (s *Storage) Write(path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)

func (*Storage) WriteMultipart 

func (s *Storage) WriteMultipart(o *Object, r io.Reader, size int64, index int, pairs ...Pair) (n int64, part *Part, err error)

func (*Storage) WriteMultipartWithContext 

func (s *Storage) WriteMultipartWithContext(ctx context.Context, o *Object, r io.Reader, size int64, index int, pairs ...Pair) (n int64, part *Part, err error)

func (*Storage) WriteWithContext 

func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)

type StorageFeatures 

type StorageFeatures struct {
	// provide simulated operations.
	//
	// - If this feature is disabled (the default behavior), the service will behave like it doesn't have
	// any dir support.
	// - If this feature is enabled, the service will support simulated dir behavior in create_dir, create,
	// list, delete, and so on.
	//
	// This feature was introduced in GSP-109.
	VirtualDir bool
}

type StorageSystemMetadata 

type StorageSystemMetadata struct {
	ServerSideEncryption                  string
	ServerSideEncryptionCosKmsKeyID       string
	ServerSideEncryptionCustomerAlgorithm string
	ServerSideEncryptionCustomerKeyMd5    string
	StorageClass                          string
}

StorageSystemMetadata stores system metadata for object.

func GetStorageSystemMetadata 

func GetStorageSystemMetadata(s *StorageMeta) StorageSystemMetadata

GetStorageSystemMetadata will get StorageSystemMetadata from Storage.

- This function should not be called by service implementer. - The returning StorageServiceMetadata is read only and should not be modified.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.