update the comment for godoc
This commit is contained in:
@@ -8,13 +8,13 @@ import (
|
||||
"net/http"
|
||||
)
|
||||
|
||||
// InitiateMultipartUploadOptions ...
|
||||
// InitiateMultipartUploadOptions is the option of InitateMultipartUpload
|
||||
type InitiateMultipartUploadOptions struct {
|
||||
*ACLHeaderOptions
|
||||
*ObjectPutHeaderOptions
|
||||
}
|
||||
|
||||
// InitiateMultipartUploadResult ...
|
||||
// InitiateMultipartUploadResult is the result of InitateMultipartUpload
|
||||
type InitiateMultipartUploadResult struct {
|
||||
XMLName xml.Name `xml:"InitiateMultipartUploadResult"`
|
||||
Bucket string
|
||||
@@ -22,9 +22,7 @@ type InitiateMultipartUploadResult struct {
|
||||
UploadID string `xml:"UploadId"`
|
||||
}
|
||||
|
||||
// InitiateMultipartUpload ...
|
||||
//
|
||||
// Initiate Multipart Upload请求实现初始化分片上传,成功执行此请求以后会返回Upload ID用于后续的Upload Part请求。
|
||||
// InitiateMultipartUpload 请求实现初始化分片上传,成功执行此请求以后会返回Upload ID用于后续的Upload Part请求。
|
||||
//
|
||||
// https://www.qcloud.com/document/product/436/7746
|
||||
func (s *ObjectService) InitiateMultipartUpload(ctx context.Context, name string, opt *InitiateMultipartUploadOptions) (*InitiateMultipartUploadResult, *Response, error) {
|
||||
@@ -40,17 +38,14 @@ func (s *ObjectService) InitiateMultipartUpload(ctx context.Context, name string
|
||||
return &res, resp, err
|
||||
}
|
||||
|
||||
// ObjectUploadPartOptions ...
|
||||
// ObjectUploadPartOptions is the options of upload-part
|
||||
type ObjectUploadPartOptions struct {
|
||||
Expect string `header:"Expect,omitempty" url:"-"`
|
||||
XCosContentSHA1 string `header:"x-cos-content-sha1" url:"-"`
|
||||
ContentLength int `header:"Content-Length,omitempty" url:"-"`
|
||||
}
|
||||
|
||||
|
||||
// UploadPart ...
|
||||
//
|
||||
// Upload Part请求实现在初始化以后的分块上传,支持的块的数量为1到10000,块的大小为1 MB 到5 GB。
|
||||
// UploadPart 请求实现在初始化以后的分块上传,支持的块的数量为1到10000,块的大小为1 MB 到5 GB。
|
||||
// 在每次请求Upload Part时候,需要携带partNumber和uploadID,partNumber为块的编号,支持乱序上传。
|
||||
//
|
||||
// 当传入uploadID和partNumber都相同的时候,后传入的块将覆盖之前传入的块。当uploadID不存在时会返回404错误,NoSuchUpload.
|
||||
@@ -71,14 +66,14 @@ func (s *ObjectService) UploadPart(ctx context.Context, name, uploadID string, p
|
||||
return resp, err
|
||||
}
|
||||
|
||||
// ObjectListPartsOptions ...
|
||||
// ObjectListPartsOptions is the option of ListParts
|
||||
type ObjectListPartsOptions struct {
|
||||
EncodingType string `url:"Encoding-type,omitempty"`
|
||||
MaxParts int `url:"max-parts,omitempty"`
|
||||
PartNumberMarker int `url:"part-number-marker,omitempty"`
|
||||
}
|
||||
|
||||
// ObjectListPartsResult ...
|
||||
// ObjectListPartsResult is the result of ListParts
|
||||
type ObjectListPartsResult struct {
|
||||
XMLName xml.Name `xml:"ListPartsResult"`
|
||||
Bucket string
|
||||
@@ -95,9 +90,7 @@ type ObjectListPartsResult struct {
|
||||
Parts []Object `xml:"Part,omitempty"`
|
||||
}
|
||||
|
||||
// ListParts ...
|
||||
//
|
||||
// List Parts用来查询特定分块上传中的已上传的块。
|
||||
// ListParts 用来查询特定分块上传中的已上传的块。
|
||||
//
|
||||
// https://www.qcloud.com/document/product/436/7747
|
||||
func (s *ObjectService) ListParts(ctx context.Context, name, uploadID string) (*ObjectListPartsResult, *Response, error) {
|
||||
@@ -113,13 +106,13 @@ func (s *ObjectService) ListParts(ctx context.Context, name, uploadID string) (*
|
||||
return &res, resp, err
|
||||
}
|
||||
|
||||
// CompleteMultipartUploadOptions ...
|
||||
// CompleteMultipartUploadOptions is the option of CompleteMultipartUpload
|
||||
type CompleteMultipartUploadOptions struct {
|
||||
XMLName xml.Name `xml:"CompleteMultipartUpload"`
|
||||
Parts []Object `xml:"Part"`
|
||||
}
|
||||
|
||||
// CompleteMultipartUploadResult ...
|
||||
// CompleteMultipartUploadResult is the result CompleteMultipartUpload
|
||||
type CompleteMultipartUploadResult struct {
|
||||
XMLName xml.Name `xml:"CompleteMultipartUploadResult"`
|
||||
Location string
|
||||
@@ -128,9 +121,7 @@ type CompleteMultipartUploadResult struct {
|
||||
ETag string
|
||||
}
|
||||
|
||||
// CompleteMultipartUpload ...
|
||||
//
|
||||
// Complete Multipart Upload用来实现完成整个分块上传。当您已经使用Upload Parts上传所有块以后,你可以用该API完成上传。
|
||||
// CompleteMultipartUpload 用来实现完成整个分块上传。当您已经使用Upload Parts上传所有块以后,你可以用该API完成上传。
|
||||
// 在使用该API时,您必须在Body中给出每一个块的PartNumber和ETag,用来校验块的准确性。
|
||||
//
|
||||
// 由于分块上传的合并需要数分钟时间,因而当合并分块开始的时候,COS就立即返回200的状态码,在合并的过程中,
|
||||
@@ -158,9 +149,7 @@ func (s *ObjectService) CompleteMultipartUpload(ctx context.Context, name, uploa
|
||||
return &res, resp, err
|
||||
}
|
||||
|
||||
// AbortMultipartUpload ...
|
||||
//
|
||||
// Abort Multipart Upload用来实现舍弃一个分块上传并删除已上传的块。当您调用Abort Multipart Upload时,
|
||||
// AbortMultipartUpload 用来实现舍弃一个分块上传并删除已上传的块。当您调用Abort Multipart Upload时,
|
||||
// 如果有正在使用这个Upload Parts上传块的请求,则Upload Parts会返回失败。当该UploadID不存在时,会返回404 NoSuchUpload。
|
||||
//
|
||||
// 建议您及时完成分块上传或者舍弃分块上传,因为已上传但是未终止的块会占用存储空间进而产生存储费用。
|
||||
|
||||
Reference in New Issue
Block a user