Documentation ¶
Overview ¶
Package gcs provided support for Google Cloud Storage (https://cloud.google.com/storage/)
Code generated by go generate via cmd/definitions; DO NOT EDIT.
Index ¶
- Constants
- 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 WithDefaultServicePairs(v DefaultServicePairs) Pair
- func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
- func WithEnableVirtualDir() Pair
- func WithEncryptionKey(v []byte) Pair
- func WithKmsKeyName(v string) Pair
- func WithProjectID(v string) Pair
- func WithServiceFeatures(v ServiceFeatures) Pair
- func WithStorageClass(v string) 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) Create(path string, pairs ...Pair) (o *Object)
- 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) WriteWithContext(ctx context.Context, path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- type StorageFeatures
- type StorageSystemMetadata
Constants ¶
const ( StorageClassStandard = "STANDARD" StorageClassNearLine = "NEARLINE" StorageClassColdLine = "COLDLINE" StorageClassArchive = "ARCHIVE" )
All available storage classes are listed here.
const Type = "gcs"
Type is the type for gcs
Variables ¶
This section is empty.
Functions ¶
func NewServicer ¶
NewServicer will create Servicer only.
func NewStorager ¶
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 WithEncryptionKey ¶
func WithEncryptionKey(v []byte) Pair
WithEncryptionKey will apply encryption_key value to Options.
is the customer's 32-byte AES-256 key
func WithKmsKeyName ¶
func WithKmsKeyName(v string) Pair
WithKmsKeyName will apply kms_key_name value to Options.
is the Cloud KMS key resource. For example, `projects/my-pet-project/locations/us-east1/keyRings/my-key-ring/cryptoKeys/my-key`.
Refer to https://cloud.google.com/storage/docs/encryption/using-customer-managed-keys#add-object-key for more details.
func WithProjectID ¶
func WithProjectID(v string) Pair
WithProjectID will apply project_id value to Options.
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 { Create []Pair CreateDir []Pair Delete []Pair List []Pair Metadata []Pair Read []Pair Stat []Pair Write []Pair }
DefaultStoragePairs is default pairs for specific action
type ObjectSystemMetadata ¶
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 gcs 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.UnimplementedDirer // contains filtered or unexported fields }
Storage is the gcs service client.
func (*Storage) CreateDirWithContext ¶
func (*Storage) DeleteWithContext ¶
func (*Storage) ListWithContext ¶
func (*Storage) ReadWithContext ¶
func (*Storage) StatWithContext ¶
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 ¶
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.