Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BucketConfig ¶
type BucketConfig = uplink.BucketConfig
BucketConfig holds information about a bucket's configuration. This is filled in by the caller for use with CreateBucket(), or filled in by the library as Bucket.Config when a bucket is returned from OpenBucket().
type BucketListOptions ¶
type BucketListOptions = uplink.BucketListOptions
BucketListOptions controls options to the ListBuckets() call.
type EncryptionAccess ¶
type EncryptionAccess = uplink.EncryptionAccess
EncryptionAccess represents an encryption access context. It holds information about how various buckets and objects should be encrypted and decrypted.
func NewEncryptionAccess ¶ added in v0.14.5
func NewEncryptionAccess() *EncryptionAccess
NewEncryptionAccess creates an encryption access context
func NewEncryptionAccessWithDefaultKey ¶ added in v0.14.5
func NewEncryptionAccessWithDefaultKey(defaultKey storj.Key) *EncryptionAccess
NewEncryptionAccessWithDefaultKey creates an encryption access context with a default key set. Use (*Project).SaltedKeyFromPassphrase to generate a default key
func ParseEncryptionAccess ¶ added in v0.14.5
func ParseEncryptionAccess(serialized string) (*EncryptionAccess, error)
ParseEncryptionAccess parses a base58 serialized encryption access into a working one.
type EncryptionRestriction ¶ added in v0.14.4
type EncryptionRestriction = uplink.EncryptionRestriction
EncryptionRestriction represents a scenario where some set of objects may need to be encrypted/decrypted
type ListOptions ¶
type ListOptions = uplink.ListOptions
ListOptions controls options for the ListObjects() call.
type Object ¶
An Object is a sequence of bytes with associated metadata, stored in the Storj network (or being prepared for such storage). It belongs to a specific bucket, and has a path and a size. It is comparable to a "file" in a conventional filesystem.
type ObjectMeta ¶
type ObjectMeta = uplink.ObjectMeta
ObjectMeta contains metadata about a specific Object.
type Scope ¶ added in v0.15.0
Scope is a serializable type that represents all of the credentials you need to open a project and some amount of buckets
func ParseScope ¶ added in v0.15.0
ParseScope unmarshals a base58 encoded scope protobuf and decodes the fields into the Scope convenience type. It will return an error if the protobuf is malformed or field validation fails.
type Uplink ¶
Uplink represents the main entrypoint to Storj V3. An Uplink connects to a specific Satellite and caches connections and resources, allowing one to create sessions delineated by specific access controls.
type UploadOptions ¶
type UploadOptions = uplink.UploadOptions
UploadOptions controls options about uploading a new Object, if authorized.
Source Files