metainfo

Documentation

Index

• Variables
• type Client
  • func Dial(ctx context.Context, tc transport.Client, address string, apiKey string) (*Client, error)
  • func New(client pb.MetainfoClient) *Client
  • func (client *Client) Close() error
  • func (client *Client) CommitSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64, ...) (savedPointer *pb.Pointer, err error)
  • func (client *Client) CreateBucket(ctx context.Context, bucket storj.Bucket) (_ storj.Bucket, err error)
  • func (client *Client) CreateSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64, ...) (limits []*pb.AddressedOrderLimit, rootPieceID storj.PieceID, ...)
  • func (client *Client) DeleteBucket(ctx context.Context, bucketName string) (err error)
  • func (client *Client) DeleteSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64) (limits []*pb.AddressedOrderLimit, piecePrivateKey storj.PiecePrivateKey, ...)
  • func (client *Client) GetBucket(ctx context.Context, bucketName string) (_ storj.Bucket, err error)
  • func (client *Client) GetProjectInfo(ctx context.Context) (resp *pb.ProjectInfoResponse, err error)
  • func (client *Client) ListBuckets(ctx context.Context, listOpts storj.BucketListOptions) (_ storj.BucketList, err error)
  • func (client *Client) ListSegments(ctx context.Context, bucket string, prefix, startAfter, endBefore storj.Path, ...) (items []ListItem, more bool, err error)
  • func (client *Client) ReadSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64) (pointer *pb.Pointer, limits []*pb.AddressedOrderLimit, ...)
  • func (client *Client) SegmentInfo(ctx context.Context, bucket string, path storj.Path, segmentIndex int64) (pointer *pb.Pointer, err error)
  • func (client *Client) SetAttribution(ctx context.Context, bucket string, partnerID uuid.UUID) (err error)
• type ListItem

Variables

var (

	// Error is the errs class of standard metainfo errors
	Error = errs.Class("metainfo error")
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client creates a grpcClient

func Dial

func Dial(ctx context.Context, tc transport.Client, address string, apiKey string) (*Client, error)

Dial dials to metainfo endpoint with the specified api key.

func New

func New(client pb.MetainfoClient) *Client

New used as a public function

func (*Client) Close

func (client *Client) Close() error

Close closes the dialed connection.

func (*Client) CommitSegment

func (client *Client) CommitSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64, pointer *pb.Pointer, originalLimits []*pb.OrderLimit) (savedPointer *pb.Pointer, err error)

CommitSegment requests to store the pointer for the segment

func (*Client) CreateBucket

func (client *Client) CreateBucket(ctx context.Context, bucket storj.Bucket) (_ storj.Bucket, err error)

CreateBucket creates a new bucket

func (*Client) CreateSegment

func (client *Client) CreateSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64, redundancy *pb.RedundancyScheme, maxEncryptedSegmentSize int64, expiration time.Time) (limits []*pb.AddressedOrderLimit, rootPieceID storj.PieceID, piecePrivateKey storj.PiecePrivateKey, err error)

CreateSegment requests the order limits for creating a new segment

func (*Client) DeleteBucket

func (client *Client) DeleteBucket(ctx context.Context, bucketName string) (err error)

DeleteBucket deletes a bucket

func (*Client) DeleteSegment

func (client *Client) DeleteSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64) (limits []*pb.AddressedOrderLimit, piecePrivateKey storj.PiecePrivateKey, err error)

DeleteSegment requests the order limits for deleting a segment

func (*Client) GetBucket

func (client *Client) GetBucket(ctx context.Context, bucketName string) (_ storj.Bucket, err error)

GetBucket returns a bucket

func (*Client) GetProjectInfo

func (client *Client) GetProjectInfo(ctx context.Context) (resp *pb.ProjectInfoResponse, err error)

GetProjectInfo gets the ProjectInfo for the api key associated with the metainfo client.

func (*Client) ListBuckets

func (client *Client) ListBuckets(ctx context.Context, listOpts storj.BucketListOptions) (_ storj.BucketList, err error)

ListBuckets lists buckets

func (*Client) ListSegments

func (client *Client) ListSegments(ctx context.Context, bucket string, prefix, startAfter, endBefore storj.Path, recursive bool, limit int32, metaFlags uint32) (items []ListItem, more bool, err error)

ListSegments lists the available segments

func (*Client) ReadSegment

func (client *Client) ReadSegment(ctx context.Context, bucket string, path storj.Path, segmentIndex int64) (pointer *pb.Pointer, limits []*pb.AddressedOrderLimit, piecePrivateKey storj.PiecePrivateKey, err error)

ReadSegment requests the order limits for reading a segment

func (*Client) SegmentInfo

func (client *Client) SegmentInfo(ctx context.Context, bucket string, path storj.Path, segmentIndex int64) (pointer *pb.Pointer, err error)

SegmentInfo requests the pointer of a segment

func (*Client) SetAttribution

func (client *Client) SetAttribution(ctx context.Context, bucket string, partnerID uuid.UUID) (err error)

SetAttribution tries to set the attribution information on the bucket.

type ListItem

type ListItem struct {
	Path     storj.Path
	Pointer  *pb.Pointer
	IsPrefix bool
}

ListItem is a single item in a listing