Documentation ¶
Overview ¶
Package azblob provided support for Azure Storage containers and blobs objects (https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction)
Code generated by go generate via cmd/definitions; DO NOT EDIT.
Index ¶
- Constants
- Variables
- func New(pairs ...typ.Pair) (typ.Servicer, typ.Storager, error)
- func NewServicer(pairs ...typ.Pair) (typ.Servicer, error)
- func NewStorager(pairs ...typ.Pair) (typ.Storager, error)
- func WithAccessTier(v string) Pair
- func WithDefaultServicePairs(v DefaultServicePairs) Pair
- func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
- func WithEnableVirtualDir() Pair
- func WithEncryptionKey(v []byte) Pair
- func WithEncryptionScope(v string) Pair
- func WithServiceFeatures(v ServiceFeatures) Pair
- func WithStorageFeatures(v StorageFeatures) Pair
- type DefaultServicePairs
- type DefaultStoragePairs
- type ObjectSystemMetadata
- type Service
- func (s *Service) Create(name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) CreateWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) Delete(name string, pairs ...Pair) (err error)
- func (s *Service) DeleteWithContext(ctx context.Context, name string, pairs ...Pair) (err error)
- func (s *Service) Get(name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) GetWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) List(pairs ...Pair) (sti *StoragerIterator, err error)
- func (s *Service) ListWithContext(ctx context.Context, pairs ...Pair) (sti *StoragerIterator, err error)
- func (s *Service) String() string
- type ServiceFeatures
- type Storage
- func (s *Storage) CommitAppend(o *Object, pairs ...Pair) (err error)
- func (s *Storage) CommitAppendWithContext(ctx context.Context, o *Object, pairs ...Pair) (err error)
- func (s *Storage) Create(path string, pairs ...Pair) (o *Object)
- func (s *Storage) CreateAppend(path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateAppendWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateDir(path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateDirWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) Delete(path string, pairs ...Pair) (err error)
- func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)
- func (s *Storage) List(path string, pairs ...Pair) (oi *ObjectIterator, err error)
- func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...Pair) (oi *ObjectIterator, err error)
- func (s *Storage) Metadata(pairs ...Pair) (meta *StorageMeta)
- func (s *Storage) Read(path string, w io.Writer, pairs ...Pair) (n int64, err error)
- func (s *Storage) ReadWithContext(ctx context.Context, path string, w io.Writer, pairs ...Pair) (n int64, err error)
- func (s *Storage) Stat(path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) String() string
- func (s *Storage) Write(path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- func (s *Storage) WriteAppend(o *Object, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- func (s *Storage) WriteAppendWithContext(ctx context.Context, o *Object, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- type StorageClass
- type StorageFeatures
- type StorageSystemMetadata
Constants ¶
const ( StorageClassArchive = azblob.AccessTierArchive StorageClassCool = azblob.AccessTierCool StorageClassHot = azblob.AccessTierHot StorageClassNone = azblob.AccessTierNone )
All available storage classes are listed here.
const ( // AppendBlobIfMaxSizeLessThanOrEqual ensures that the AppendBlock operation succeeds only if the append blob's size is less than or equal to a value. // ref: https://docs.microsoft.com/rest/api/storageservices/append-block. AppendBlobIfMaxSizeLessThanOrEqual = 4 * 1024 * 1024 * 50000 // AppendSizeMaximum is the max append size in per append operation. // ref: https://docs.microsoft.com/rest/api/storageservices/append-block. AppendSizeMaximum = 4 * 1024 * 1024 // AppendNumberMaximum is the max append numbers in append operation. // ref: https://docs.microsoft.com/rest/api/storageservices/append-block. AppendNumberMaximum = 50000 // WriteSizeMaximum is the maximum size for write operation. // ref: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob WriteSizeMaximum = 5000 * 1024 * 1024 )
const Type = "azblob"
Type is the type for azblob
Variables ¶
var ( // ErrEncryptionKeyInvalid will be returned while encryption key is invalid. // Encryption key must be a 32-byte AES-256 key. ErrEncryptionKeyInvalid = services.NewErrorCode("invalid encryption key") )
Functions ¶
func NewServicer ¶
NewServicer will create Servicer only.
func NewStorager ¶
NewStorager will create Storager only.
func WithAccessTier ¶
func WithAccessTier(v string) Pair
WithAccessTier will apply access_tier value to Options.
func WithDefaultServicePairs ¶
func WithDefaultServicePairs(v DefaultServicePairs) Pair
WithDefaultServicePairs will apply default_service_pairs value to Options.
set default pairs for service actions
func WithDefaultStoragePairs ¶
func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
WithDefaultStoragePairs will apply default_storage_pairs value to Options.
set default pairs for storager actions
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 WithEncryptionKey ¶
func WithEncryptionKey(v []byte) Pair
WithEncryptionKey will apply encryption_key value to Options.
is the customer's 32-byte AES-256 key
func WithEncryptionScope ¶
func WithEncryptionScope(v string) Pair
WithEncryptionScope will apply encryption_scope value to Options.
Specifies the name of the encryption scope. See https://docs.microsoft.com/en-us/azure/storage/blobs/encryption-scope-overview for details.
func WithServiceFeatures ¶
func WithServiceFeatures(v ServiceFeatures) Pair
WithServiceFeatures will apply service_features value to Options.
set service features
func WithStorageFeatures ¶
func WithStorageFeatures(v StorageFeatures) Pair
WithStorageFeatures will apply storage_features value to Options.
set storage features
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 { CommitAppend []Pair Create []Pair CreateAppend []Pair CreateDir []Pair Delete []Pair List []Pair Metadata []Pair Read []Pair Stat []Pair Write []Pair WriteAppend []Pair }
DefaultStoragePairs is default pairs for specific action
type ObjectSystemMetadata ¶
type ObjectSystemMetadata struct { AccessTier string EncryptionKeySha256 string EncryptionScope string ServerEncrypted bool }
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 azblob config.
func (*Service) CreateWithContext ¶
func (*Service) DeleteWithContext ¶
func (*Service) GetWithContext ¶
func (*Service) ListWithContext ¶
type ServiceFeatures ¶
type ServiceFeatures struct { }
type Storage ¶
type Storage struct { typ.UnimplementedStorager typ.UnimplementedAppender typ.UnimplementedDirer // contains filtered or unexported fields }
Storage is the azblob service client.
func (*Storage) CommitAppend ¶
func (*Storage) CommitAppendWithContext ¶
func (*Storage) CreateAppend ¶
func (*Storage) CreateAppendWithContext ¶
func (*Storage) CreateDirWithContext ¶
func (*Storage) DeleteWithContext ¶
func (*Storage) ListWithContext ¶
func (*Storage) ReadWithContext ¶
func (*Storage) StatWithContext ¶
func (*Storage) WriteAppend ¶
func (*Storage) WriteAppendWithContext ¶
type StorageClass ¶
type StorageClass azblob.AccessTierType
StorageClass is the storage class used in storage lib.
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 { AccessTier string EncryptionKeySha256 string EncryptionScope string ServerEncrypted bool }
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.