uplink/metainfo: Fix doc comments
Fix some documentation comments in a few methods and apply our code style conventions to all of them in this source file of the package. Change-Id: I78186cb1e7d45020d6cf7bbea8a39d146ada1cb6
This commit is contained in:
Ivan Fraixedes
Michal Niewrzal
parent
b17d40ffd4
commit
8d49a99ad8
@ -23,11 +23,11 @@ import (
|
||||
var (
|
||||
mon = monkit.Package()
|
||||
|
||||
// Error is the errs class of standard metainfo errors
|
||||
// Error is the errs class of standard metainfo errors.
|
||||
Error = errs.Class("metainfo error")
|
||||
)
|
||||
|
||||
// Client creates a grpcClient
|
||||
// Client creates a grpcClient.
|
||||
type Client struct {
|
||||
conn *rpc.Conn
|
||||
client rpc.MetainfoClient
|
||||
@ -36,14 +36,14 @@ type Client struct {
|
||||
userAgent string
|
||||
}
|
||||
|
||||
// ListItem is a single item in a listing
|
||||
// ListItem is a single item in a listing.
|
||||
type ListItem struct {
|
||||
Path storj.Path
|
||||
Pointer *pb.Pointer
|
||||
IsPrefix bool
|
||||
}
|
||||
|
||||
// New used as a public function
|
||||
// New used as a public function.
|
||||
func New(client rpc.MetainfoClient, apiKey *macaroon.APIKey, userAgent string) *Client {
|
||||
return &Client{
|
||||
client: client,
|
||||
@ -92,7 +92,7 @@ func (client *Client) GetProjectInfo(ctx context.Context) (resp *pb.ProjectInfoR
|
||||
})
|
||||
}
|
||||
|
||||
// CreateBucketParams parameters for CreateBucket method
|
||||
// CreateBucketParams parameters for CreateBucket method.
|
||||
type CreateBucketParams struct {
|
||||
Name []byte
|
||||
PathCipher storj.CipherSuite
|
||||
@ -127,7 +127,7 @@ func (params *CreateBucketParams) toRequest(header *pb.RequestHeader) *pb.Bucket
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *CreateBucketParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_BucketCreate{
|
||||
@ -138,7 +138,7 @@ func (params *CreateBucketParams) BatchItem() *pb.BatchRequestItem {
|
||||
|
||||
// TODO potential names *Response/*Out/*Result
|
||||
|
||||
// CreateBucketResponse response for CreateBucket request
|
||||
// CreateBucketResponse response for CreateBucket request.
|
||||
type CreateBucketResponse struct {
|
||||
Bucket storj.Bucket
|
||||
}
|
||||
@ -153,7 +153,7 @@ func newCreateBucketResponse(response *pb.BucketCreateResponse) (CreateBucketRes
|
||||
}, nil
|
||||
}
|
||||
|
||||
// CreateBucket creates a new bucket
|
||||
// CreateBucket creates a new bucket.
|
||||
func (client *Client) CreateBucket(ctx context.Context, params CreateBucketParams) (respBucket storj.Bucket, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -169,7 +169,7 @@ func (client *Client) CreateBucket(ctx context.Context, params CreateBucketParam
|
||||
return respBucket, nil
|
||||
}
|
||||
|
||||
// GetBucketParams parmaters for GetBucketParams method
|
||||
// GetBucketParams parmaters for GetBucketParams method.
|
||||
type GetBucketParams struct {
|
||||
Name []byte
|
||||
}
|
||||
@ -181,7 +181,7 @@ func (params *GetBucketParams) toRequest(header *pb.RequestHeader) *pb.BucketGet
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *GetBucketParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_BucketGet{
|
||||
@ -190,7 +190,7 @@ func (params *GetBucketParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// GetBucketResponse response for GetBucket request
|
||||
// GetBucketResponse response for GetBucket request.
|
||||
type GetBucketResponse struct {
|
||||
Bucket storj.Bucket
|
||||
}
|
||||
@ -205,7 +205,7 @@ func newGetBucketResponse(response *pb.BucketGetResponse) (GetBucketResponse, er
|
||||
}, nil
|
||||
}
|
||||
|
||||
// GetBucket returns a bucket
|
||||
// GetBucket returns a bucket.
|
||||
func (client *Client) GetBucket(ctx context.Context, params GetBucketParams) (respBucket storj.Bucket, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -224,7 +224,7 @@ func (client *Client) GetBucket(ctx context.Context, params GetBucketParams) (re
|
||||
return respBucket, nil
|
||||
}
|
||||
|
||||
// DeleteBucketParams parmaters for DeleteBucket method
|
||||
// DeleteBucketParams parmaters for DeleteBucket method.
|
||||
type DeleteBucketParams struct {
|
||||
Name []byte
|
||||
}
|
||||
@ -236,7 +236,7 @@ func (params *DeleteBucketParams) toRequest(header *pb.RequestHeader) *pb.Bucket
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *DeleteBucketParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_BucketDelete{
|
||||
@ -245,7 +245,7 @@ func (params *DeleteBucketParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// DeleteBucket deletes a bucket
|
||||
// DeleteBucket deletes a bucket.
|
||||
func (client *Client) DeleteBucket(ctx context.Context, params DeleteBucketParams) (err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
_, err = client.client.DeleteBucket(ctx, params.toRequest(client.header()))
|
||||
@ -258,7 +258,7 @@ func (client *Client) DeleteBucket(ctx context.Context, params DeleteBucketParam
|
||||
return nil
|
||||
}
|
||||
|
||||
// ListBucketsParams parmaters for ListBucketsParams method
|
||||
// ListBucketsParams parmaters for ListBucketsParams method.
|
||||
type ListBucketsParams struct {
|
||||
ListOpts storj.BucketListOptions
|
||||
}
|
||||
@ -272,7 +272,7 @@ func (params *ListBucketsParams) toRequest(header *pb.RequestHeader) *pb.BucketL
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *ListBucketsParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_BucketList{
|
||||
@ -281,7 +281,7 @@ func (params *ListBucketsParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// ListBucketsResponse response for ListBucket request
|
||||
// ListBucketsResponse response for ListBucket request.
|
||||
type ListBucketsResponse struct {
|
||||
BucketList storj.BucketList
|
||||
}
|
||||
@ -302,7 +302,7 @@ func newListBucketsResponse(response *pb.BucketListResponse) ListBucketsResponse
|
||||
}
|
||||
}
|
||||
|
||||
// ListBuckets lists buckets
|
||||
// ListBuckets lists buckets.
|
||||
func (client *Client) ListBuckets(ctx context.Context, params ListBucketsParams) (_ storj.BucketList, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -352,7 +352,7 @@ func convertProtoToBucket(pbBucket *pb.Bucket) (bucket storj.Bucket, err error)
|
||||
}, nil
|
||||
}
|
||||
|
||||
// SetBucketAttributionParams parameters for SetBucketAttribution method
|
||||
// SetBucketAttributionParams parameters for SetBucketAttribution method.
|
||||
type SetBucketAttributionParams struct {
|
||||
Bucket string
|
||||
PartnerID uuid.UUID
|
||||
@ -371,7 +371,7 @@ func (params *SetBucketAttributionParams) toRequest(header *pb.RequestHeader) *p
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *SetBucketAttributionParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_BucketSetAttribution{
|
||||
@ -389,7 +389,7 @@ func (client *Client) SetBucketAttribution(ctx context.Context, params SetBucket
|
||||
return Error.Wrap(err)
|
||||
}
|
||||
|
||||
// BeginObjectParams parmaters for BeginObject method
|
||||
// BeginObjectParams parmaters for BeginObject method.
|
||||
type BeginObjectParams struct {
|
||||
Bucket []byte
|
||||
EncryptedPath []byte
|
||||
@ -421,7 +421,7 @@ func (params *BeginObjectParams) toRequest(header *pb.RequestHeader) *pb.ObjectB
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request....
|
||||
func (params *BeginObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_ObjectBegin{
|
||||
@ -430,7 +430,7 @@ func (params *BeginObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// BeginObjectResponse response for BeginObject request
|
||||
// BeginObjectResponse response for BeginObject request.
|
||||
type BeginObjectResponse struct {
|
||||
StreamID storj.StreamID
|
||||
}
|
||||
@ -441,7 +441,7 @@ func newBeginObjectResponse(response *pb.ObjectBeginResponse) BeginObjectRespons
|
||||
}
|
||||
}
|
||||
|
||||
// BeginObject begins object creation
|
||||
// BeginObject begins object creation.
|
||||
func (client *Client) BeginObject(ctx context.Context, params BeginObjectParams) (_ storj.StreamID, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -453,7 +453,7 @@ func (client *Client) BeginObject(ctx context.Context, params BeginObjectParams)
|
||||
return response.StreamId, nil
|
||||
}
|
||||
|
||||
// CommitObjectParams parmaters for CommitObject method
|
||||
// CommitObjectParams parmaters for CommitObject method.
|
||||
type CommitObjectParams struct {
|
||||
StreamID storj.StreamID
|
||||
|
||||
@ -470,7 +470,7 @@ func (params *CommitObjectParams) toRequest(header *pb.RequestHeader) *pb.Object
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *CommitObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_ObjectCommit{
|
||||
@ -479,7 +479,7 @@ func (params *CommitObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// CommitObject commits created object
|
||||
// CommitObject commits a created object.
|
||||
func (client *Client) CommitObject(ctx context.Context, params CommitObjectParams) (err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -488,7 +488,7 @@ func (client *Client) CommitObject(ctx context.Context, params CommitObjectParam
|
||||
return Error.Wrap(err)
|
||||
}
|
||||
|
||||
// GetObjectParams parameters for GetObject method
|
||||
// GetObjectParams parameters for GetObject method.
|
||||
type GetObjectParams struct {
|
||||
Bucket []byte
|
||||
EncryptedPath []byte
|
||||
@ -504,7 +504,7 @@ func (params *GetObjectParams) toRequest(header *pb.RequestHeader) *pb.ObjectGet
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *GetObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_ObjectGet{
|
||||
@ -513,7 +513,7 @@ func (params *GetObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// GetObjectResponse response for GetObject request
|
||||
// GetObjectResponse response for GetObject request.
|
||||
type GetObjectResponse struct {
|
||||
Info storj.ObjectInfo
|
||||
}
|
||||
@ -554,7 +554,7 @@ func newGetObjectResponse(response *pb.ObjectGetResponse) GetObjectResponse {
|
||||
}
|
||||
}
|
||||
|
||||
// GetObject gets single object
|
||||
// GetObject gets single object.
|
||||
func (client *Client) GetObject(ctx context.Context, params GetObjectParams) (_ storj.ObjectInfo, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -571,7 +571,7 @@ func (client *Client) GetObject(ctx context.Context, params GetObjectParams) (_
|
||||
return getResponse.Info, nil
|
||||
}
|
||||
|
||||
// BeginDeleteObjectParams parameters for BeginDeleteObject method
|
||||
// BeginDeleteObjectParams parameters for BeginDeleteObject method.
|
||||
type BeginDeleteObjectParams struct {
|
||||
Bucket []byte
|
||||
EncryptedPath []byte
|
||||
@ -587,7 +587,7 @@ func (params *BeginDeleteObjectParams) toRequest(header *pb.RequestHeader) *pb.O
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *BeginDeleteObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_ObjectBeginDelete{
|
||||
@ -596,7 +596,7 @@ func (params *BeginDeleteObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// BeginDeleteObjectResponse response for BeginDeleteObject request
|
||||
// BeginDeleteObjectResponse response for BeginDeleteObject request.
|
||||
type BeginDeleteObjectResponse struct {
|
||||
StreamID storj.StreamID
|
||||
}
|
||||
@ -607,7 +607,7 @@ func newBeginDeleteObjectResponse(response *pb.ObjectBeginDeleteResponse) BeginD
|
||||
}
|
||||
}
|
||||
|
||||
// BeginDeleteObject begins object deletion process
|
||||
// BeginDeleteObject begins object deletion process.
|
||||
func (client *Client) BeginDeleteObject(ctx context.Context, params BeginDeleteObjectParams) (_ storj.StreamID, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -622,7 +622,7 @@ func (client *Client) BeginDeleteObject(ctx context.Context, params BeginDeleteO
|
||||
return response.StreamId, nil
|
||||
}
|
||||
|
||||
// FinishDeleteObjectParams parameters for FinishDeleteObject method
|
||||
// FinishDeleteObjectParams parameters for FinishDeleteObject method.
|
||||
type FinishDeleteObjectParams struct {
|
||||
StreamID storj.StreamID
|
||||
}
|
||||
@ -634,7 +634,7 @@ func (params *FinishDeleteObjectParams) toRequest(header *pb.RequestHeader) *pb.
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *FinishDeleteObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_ObjectFinishDelete{
|
||||
@ -643,7 +643,7 @@ func (params *FinishDeleteObjectParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// FinishDeleteObject finishes object deletion process
|
||||
// FinishDeleteObject finishes object deletion process.
|
||||
func (client *Client) FinishDeleteObject(ctx context.Context, params FinishDeleteObjectParams) (err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -652,7 +652,7 @@ func (client *Client) FinishDeleteObject(ctx context.Context, params FinishDelet
|
||||
return Error.Wrap(err)
|
||||
}
|
||||
|
||||
// ListObjectsParams parameters for ListObjects method
|
||||
// ListObjectsParams parameters for ListObjects method.
|
||||
type ListObjectsParams struct {
|
||||
Bucket []byte
|
||||
EncryptedPrefix []byte
|
||||
@ -676,7 +676,7 @@ func (params *ListObjectsParams) toRequest(header *pb.RequestHeader) *pb.ObjectL
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *ListObjectsParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_ObjectList{
|
||||
@ -685,7 +685,7 @@ func (params *ListObjectsParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// ListObjectsResponse response for ListObjects request
|
||||
// ListObjectsResponse response for ListObjects request.
|
||||
type ListObjectsResponse struct {
|
||||
Items []storj.ObjectListItem
|
||||
More bool
|
||||
@ -720,7 +720,7 @@ func newListObjectsResponse(response *pb.ObjectListResponse, encryptedPrefix []b
|
||||
}
|
||||
}
|
||||
|
||||
// ListObjects lists objects according to specific parameters
|
||||
// ListObjects lists objects according to specific parameters.
|
||||
func (client *Client) ListObjects(ctx context.Context, params ListObjectsParams) (_ []storj.ObjectListItem, more bool, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -733,7 +733,7 @@ func (client *Client) ListObjects(ctx context.Context, params ListObjectsParams)
|
||||
return listResponse.Items, listResponse.More, Error.Wrap(err)
|
||||
}
|
||||
|
||||
// BeginSegmentParams parameters for BeginSegment method
|
||||
// BeginSegmentParams parameters for BeginSegment method.
|
||||
type BeginSegmentParams struct {
|
||||
StreamID storj.StreamID
|
||||
Position storj.SegmentPosition
|
||||
@ -752,7 +752,7 @@ func (params *BeginSegmentParams) toRequest(header *pb.RequestHeader) *pb.Segmen
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *BeginSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_SegmentBegin{
|
||||
@ -761,7 +761,7 @@ func (params *BeginSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// BeginSegmentResponse response for BeginSegment request
|
||||
// BeginSegmentResponse response for BeginSegment request.
|
||||
type BeginSegmentResponse struct {
|
||||
SegmentID storj.SegmentID
|
||||
Limits []*pb.AddressedOrderLimit
|
||||
@ -776,7 +776,7 @@ func newBeginSegmentResponse(response *pb.SegmentBeginResponse) BeginSegmentResp
|
||||
}
|
||||
}
|
||||
|
||||
// BeginSegment begins segment upload
|
||||
// BeginSegment begins a segment upload.
|
||||
func (client *Client) BeginSegment(ctx context.Context, params BeginSegmentParams) (_ storj.SegmentID, limits []*pb.AddressedOrderLimit, piecePrivateKey storj.PiecePrivateKey, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -788,7 +788,7 @@ func (client *Client) BeginSegment(ctx context.Context, params BeginSegmentParam
|
||||
return response.SegmentId, response.AddressedLimits, response.PrivateKey, nil
|
||||
}
|
||||
|
||||
// CommitSegmentParams parameters for CommitSegment method
|
||||
// CommitSegmentParams parameters for CommitSegment method.
|
||||
type CommitSegmentParams struct {
|
||||
SegmentID storj.SegmentID
|
||||
Encryption storj.SegmentEncryption
|
||||
@ -809,7 +809,7 @@ func (params *CommitSegmentParams) toRequest(header *pb.RequestHeader) *pb.Segme
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *CommitSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_SegmentCommit{
|
||||
@ -818,7 +818,7 @@ func (params *CommitSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// CommitSegment commits segment after upload
|
||||
// CommitSegment commits an uploaded segment.
|
||||
func (client *Client) CommitSegment(ctx context.Context, params CommitSegmentParams) (err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -827,7 +827,7 @@ func (client *Client) CommitSegment(ctx context.Context, params CommitSegmentPar
|
||||
return Error.Wrap(err)
|
||||
}
|
||||
|
||||
// MakeInlineSegmentParams parameters for MakeInlineSegment method
|
||||
// MakeInlineSegmentParams parameters for MakeInlineSegment method.
|
||||
type MakeInlineSegmentParams struct {
|
||||
StreamID storj.StreamID
|
||||
Position storj.SegmentPosition
|
||||
@ -849,7 +849,7 @@ func (params *MakeInlineSegmentParams) toRequest(header *pb.RequestHeader) *pb.S
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *MakeInlineSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_SegmentMakeInline{
|
||||
@ -858,7 +858,7 @@ func (params *MakeInlineSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// MakeInlineSegment commits segment after upload
|
||||
// MakeInlineSegment creates an inline segment.
|
||||
func (client *Client) MakeInlineSegment(ctx context.Context, params MakeInlineSegmentParams) (err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -867,7 +867,7 @@ func (client *Client) MakeInlineSegment(ctx context.Context, params MakeInlineSe
|
||||
return Error.Wrap(err)
|
||||
}
|
||||
|
||||
// BeginDeleteSegmentParams parameters for BeginDeleteSegment method
|
||||
// BeginDeleteSegmentParams parameters for BeginDeleteSegment method.
|
||||
type BeginDeleteSegmentParams struct {
|
||||
StreamID storj.StreamID
|
||||
Position storj.SegmentPosition
|
||||
@ -884,7 +884,7 @@ func (params *BeginDeleteSegmentParams) toRequest(header *pb.RequestHeader) *pb.
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *BeginDeleteSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_SegmentBeginDelete{
|
||||
@ -893,7 +893,7 @@ func (params *BeginDeleteSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// BeginDeleteSegmentResponse response for BeginDeleteSegment request
|
||||
// BeginDeleteSegmentResponse response for BeginDeleteSegment request.
|
||||
type BeginDeleteSegmentResponse struct {
|
||||
SegmentID storj.SegmentID
|
||||
Limits []*pb.AddressedOrderLimit
|
||||
@ -908,7 +908,7 @@ func newBeginDeleteSegmentResponse(response *pb.SegmentBeginDeleteResponse) Begi
|
||||
}
|
||||
}
|
||||
|
||||
// BeginDeleteSegment begins segment upload process
|
||||
// BeginDeleteSegment begins segment deletion process.
|
||||
func (client *Client) BeginDeleteSegment(ctx context.Context, params BeginDeleteSegmentParams) (_ storj.SegmentID, limits []*pb.AddressedOrderLimit, _ storj.PiecePrivateKey, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -920,7 +920,7 @@ func (client *Client) BeginDeleteSegment(ctx context.Context, params BeginDelete
|
||||
return response.SegmentId, response.AddressedLimits, response.PrivateKey, nil
|
||||
}
|
||||
|
||||
// FinishDeleteSegmentParams parameters for FinishDeleteSegment method
|
||||
// FinishDeleteSegmentParams parameters for FinishDeleteSegment method.
|
||||
type FinishDeleteSegmentParams struct {
|
||||
SegmentID storj.SegmentID
|
||||
|
||||
@ -935,7 +935,7 @@ func (params *FinishDeleteSegmentParams) toRequest(header *pb.RequestHeader) *pb
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *FinishDeleteSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_SegmentFinishDelete{
|
||||
@ -944,7 +944,7 @@ func (params *FinishDeleteSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// FinishDeleteSegment finishes segment upload process
|
||||
// FinishDeleteSegment finishes segment upload process.
|
||||
func (client *Client) FinishDeleteSegment(ctx context.Context, params FinishDeleteSegmentParams) (err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -953,7 +953,7 @@ func (client *Client) FinishDeleteSegment(ctx context.Context, params FinishDele
|
||||
return Error.Wrap(err)
|
||||
}
|
||||
|
||||
// DownloadSegmentParams parameters for DownloadSegment method
|
||||
// DownloadSegmentParams parameters for DownloadSegment method.
|
||||
type DownloadSegmentParams struct {
|
||||
StreamID storj.StreamID
|
||||
Position storj.SegmentPosition
|
||||
@ -970,7 +970,7 @@ func (params *DownloadSegmentParams) toRequest(header *pb.RequestHeader) *pb.Seg
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *DownloadSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_SegmentDownload{
|
||||
@ -979,7 +979,7 @@ func (params *DownloadSegmentParams) BatchItem() *pb.BatchRequestItem {
|
||||
}
|
||||
}
|
||||
|
||||
// DownloadSegmentResponse response for DownloadSegment request
|
||||
// DownloadSegmentResponse response for DownloadSegment request.
|
||||
type DownloadSegmentResponse struct {
|
||||
Info storj.SegmentDownloadInfo
|
||||
|
||||
@ -1015,7 +1015,8 @@ func newDownloadSegmentResponse(response *pb.SegmentDownloadResponse) DownloadSe
|
||||
}
|
||||
}
|
||||
|
||||
// DownloadSegment gets info for downloading remote segment or data from inline segment
|
||||
// DownloadSegment gets information for downloading remote segment or data
|
||||
// from an inline segment.
|
||||
func (client *Client) DownloadSegment(ctx context.Context, params DownloadSegmentParams) (_ storj.SegmentDownloadInfo, _ []*pb.AddressedOrderLimit, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -1031,14 +1032,14 @@ func (client *Client) DownloadSegment(ctx context.Context, params DownloadSegmen
|
||||
return downloadResponse.Info, downloadResponse.Limits, nil
|
||||
}
|
||||
|
||||
// ListSegmentsParams parameters for ListSegment method
|
||||
// ListSegmentsParams parameters for ListSegment method.
|
||||
type ListSegmentsParams struct {
|
||||
StreamID storj.StreamID
|
||||
CursorPosition storj.SegmentPosition
|
||||
Limit int32
|
||||
}
|
||||
|
||||
// ListSegmentsResponse response for ListSegments request
|
||||
// ListSegmentsResponse response for ListSegments request.
|
||||
type ListSegmentsResponse struct {
|
||||
Items []storj.SegmentListItem
|
||||
More bool
|
||||
@ -1056,7 +1057,7 @@ func (params *ListSegmentsParams) toRequest(header *pb.RequestHeader) *pb.Segmen
|
||||
}
|
||||
}
|
||||
|
||||
// BatchItem returns single item for batch request
|
||||
// BatchItem returns single item for batch request.
|
||||
func (params *ListSegmentsParams) BatchItem() *pb.BatchRequestItem {
|
||||
return &pb.BatchRequestItem{
|
||||
Request: &pb.BatchRequestItem_SegmentList{
|
||||
@ -1081,7 +1082,7 @@ func newListSegmentsResponse(response *pb.SegmentListResponse) ListSegmentsRespo
|
||||
}
|
||||
}
|
||||
|
||||
// ListSegments lists object segments
|
||||
// ListSegments lists object segments.
|
||||
func (client *Client) ListSegments(ctx context.Context, params ListSegmentsParams) (_ []storj.SegmentListItem, more bool, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
@ -1097,7 +1098,7 @@ func (client *Client) ListSegments(ctx context.Context, params ListSegmentsParam
|
||||
return listResponse.Items, listResponse.More, Error.Wrap(err)
|
||||
}
|
||||
|
||||
// Batch sends multiple requests in one batch
|
||||
// Batch sends multiple requests in one batch.
|
||||
func (client *Client) Batch(ctx context.Context, requests ...BatchItem) (resp []BatchResponse, err error) {
|
||||
defer mon.Task()(&ctx)(&err)
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user