How can we use UploadOptions , DownloadOptions , ListObjectsOptions and ListBucketsOptions

shivam201312 · May 13, 2020, 4:14am

Hi… I haven’t found any documentation to what options should be set and what they mean for these structures in uplink-c .

UploadOptions
DownloadOptions
ListObjectsOptions
ListBucketsOptions

TopperDEL · May 13, 2020, 7:23am

This is indeed hard to find, currently. The base is in the “uplink”-repository, where uplink-c is based on.

So for DownloadOptions see here: https://github.com/storj/uplink/blob/7bbef5a093dc73df62e33b6ab80accb34e723c97/download.go#L14

UploadOptions:

github.com

storj/uplink/blob/7bbef5a093dc73df62e33b6ab80accb34e723c97/upload.go#L24


	"storj.io/common/pb"
	"storj.io/common/storj"
	"storj.io/uplink/private/metainfo/kvmetainfo"
	"storj.io/uplink/private/stream"
)


// ErrUploadDone is returned when either Abort or Commit has already been called.
var ErrUploadDone = errors.New("upload done")


// UploadOptions contains additional options for uploading.
type UploadOptions struct {
	// When Expires is zero, there is no expiration.
	Expires time.Time
}


// UploadObject starts an upload to the specific key.
func (project *Project) UploadObject(ctx context.Context, bucket, key string, options *UploadOptions) (upload *Upload, err error) {
	defer mon.Func().ResetTrace(&ctx)(&err)


	if bucket == "" {
		return nil, errwrapf("%w (%q)", ErrBucketNameInvalid, bucket)

ListOptions:

github.com

storj/uplink/blob/7bbef5a093dc73df62e33b6ab80accb34e723c97/objects.go#L13




package uplink


import (
	"context"


	"storj.io/common/storj"
)


// ListObjectsOptions defines object listing options.
type ListObjectsOptions struct {
	// Prefix allows to filter objects by a key prefix. If not empty, it must end with slash.
	Prefix string
	// Cursor sets the starting position of the iterator. The first item listed will be the one after the cursor.
	Cursor string
	// Recursive iterates the objects without collapsing prefixes.
	Recursive bool


	// System includes SystemMetadata in the results.
	System bool
	// Custom includes CustomMetadata in the results.

ListBuckets:

github.com

storj/uplink/blob/7bbef5a093dc73df62e33b6ab80accb34e723c97/buckets.go#L13




package uplink


import (
	"context"


	"storj.io/common/storj"
)


// ListBucketsOptions defines bucket listing options.
type ListBucketsOptions struct {
	// Cursor sets the starting position of the iterator. The first item listed will be the one after the cursor.
	Cursor string
}


// ListBuckets returns an iterator over the buckets.
func (project *Project) ListBuckets(ctx context.Context, options *ListBucketsOptions) *BucketIterator {
	defer mon.Func().ResetTrace(&ctx)(nil)


	opts := storj.BucketListOptions{
		Direction: storj.After,

I just yesterday have been in a call with storj and we talked about this one. uplink-c needs a little more documentation here.

shivam201312 · May 13, 2020, 8:07am

@TopperDEL Thank you