public interface SimpleCosXml extends BaseCosXml
提供用于访问Tencent Cloud COS服务的简单接口。[全面接口请使用 CosXml
]
对象存储(Cloud Object Storage,COS)是腾讯云提供的一种存储海量文件的分布式存储服务,用户可通过网络随时存储和查看数据。腾讯云 COS 使所有用户都能使用具备高扩展性、低成本、可靠和安全的数据存储服务。
SimpleCosXml为每个接口都提供了同步和异步操作,如同步接口为putObject(PutObjectRequest)
,
则对应的异步接口为putObjectAsync(PutObjectRequest, CosXmlResultListener)
.
更多信息请参见: 腾讯云COS文档 腾讯云COS XML API文档
注意:这里封装的是COS XML接口,COS JSON接口相关的SDK请参见COS V4,由于COS XML接口相比JSON接口 有更丰富的特性,因此我们更推荐您使用XML SDK。
basePutObject, basePutObjectAsync, cancel, cancelAll, getObject, getObject, getObjectAsync, getObjectUrl, release, uploadPart, uploadPartAsync
PutObjectResult putObject(PutObjectRequest request) throws CosXmlClientException, CosXmlServiceException
简单上传的同步方法.
简单上传主要适用于在单个请求中上传一个小于 5 GB 大小的对象. 对于大于 5 GB 的对象(或者在高带宽或弱网络环境中)优先使用分片上传的方式 (https://cloud.tencent.com/document/product/436/14112).
功能描述:https://cloud.tencent.com/document/product/436/14113.
API 接口:https://cloud.tencent.com/document/product/436/7749.
SDK 示例:简单上传对象示例
request
- 简单上传请求 PutObjectRequest
PutObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void putObjectAsync(PutObjectRequest request, CosXmlResultListener cosXmlResultListener)
简单上传的异步方法.
简单上传主要适用于在单个请求中上传一个小于 5 GB 大小的对象. 对于大于 5 GB 的对象(或者在高带宽或弱网络环境中)优先使用分片上传的方式 (https://cloud.tencent.com/document/product/436/14112).
功能描述:https://cloud.tencent.com/document/product/436/14113.
API 接口:https://cloud.tencent.com/document/product/436/7749.
SDK 示例:简单上传对象示例
request
- 简单上传请求 PutObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
PostObjectResult postObject(PostObjectRequest request) throws CosXmlClientException, CosXmlServiceException
使用表单请求上传对象的同步方法.
表单上传可以将本地不超过5GB的对象(Object)以网页表单(HTML Form)的形式上传至指定存储桶中. 对于大于 5 GB 的对象(或者在高带宽或弱网络环境中)优先使用分片上传的方式 (https://cloud.tencent.com/document/product/436/14112).
API 接口:https://cloud.tencent.com/document/product/436/14690.
SDK 示例:表单上传对象示例
request
- 简单上传请求 PutObjectRequest
PutObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void postObjectAsync(PostObjectRequest request, CosXmlResultListener cosXmlResultListener)
使用表单请求上传对象的异步方法.
表单上传可以将本地不超过5GB的对象(Object)以网页表单(HTML Form)的形式上传至指定存储桶中. 对于大于 5 GB 的对象(或者在高带宽或弱网络环境中)优先使用分片上传的方式 (https://cloud.tencent.com/document/product/436/14112).
API 接口:https://cloud.tencent.com/document/product/436/14690.
SDK 示例:表单上传对象示例
request
- 简单上传请求 PutObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
DeleteObjectResult deleteObject(DeleteObjectRequest request) throws CosXmlClientException, CosXmlServiceException
删除 COS 上单个对象的同步方法.
COS 支持直接删除一个或多个对象,当仅需要删除一个对象时,只需要提供对象的名称(即对象键)即可.
功能描述:https://cloud.tencent.com/document/product/436/14119.
API 接口:https://cloud.tencent.com/document/product/436/7743.
SDK 示例:删除单个对象示例
request
- 删除 COS 上单个对象请求 DeleteObjectRequest
DeleteObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void deleteObjectAsync(DeleteObjectRequest request, CosXmlResultListener cosXmlResultListener)
删除 COS 上单个对象的异步方法.
COS 支持直接删除一个或多个对象,当仅需要删除一个对象时,只需要提供对象的名称(即对象键)即可.
功能描述:https://cloud.tencent.com/document/product/436/14119.
API 接口:https://cloud.tencent.com/document/product/436/7743.
SDK 示例:删除单个对象示例
request
- 删除 COS 上单个对象请求 DeleteObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
HeadObjectResult headObject(HeadObjectRequest request) throws CosXmlClientException, CosXmlServiceException
获取 COS 对象的元数据信息(meta data)的同步方法.
获取 COS 对象的元数据信息,需要与 Get 的权限一致.且请求是不返回消息体的.若请求中需要设置If-Modified-Since 头部,则统一采用 GMT(RFC822) 时间格式,例如:Tue, 22 Oct 2017 01:35:21 GMT.如果对象不存在,则 返回404.
API 接口:https://cloud.tencent.com/document/product/436/7745.
SDK 示例:查询对象元数据示例
request
- 获取 COS 对象的元数据信息请求 HeadObjectRequest
HeadObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void headObjectAsync(HeadObjectRequest request, CosXmlResultListener cosXmlResultListener)
获取 COS 对象的元数据信息(meta data)的异步方法.
获取 COS 对象的元数据信息,需要与 Get 的权限一致.且请求是不返回消息体的.若请求中需要设置If-Modified-Since 头部,则统一采用 GMT(RFC822) 时间格式,例如:Tue, 22 Oct 2017 01:35:21 GMT.如果对象不存在,则 返回404. API 接口:https://cloud.tencent.com/document/product/436/7745.
SDK 示例:查询对象元数据示例
request
- 获取 COS 对象的元数据信息请求 HeadObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
CopyObjectResult copyObject(CopyObjectRequest request) throws CosXmlClientException, CosXmlServiceException
简单复制对象的同步方法.
COS 中复制对象可以完成如下功能:
当复制的对象小于等于 5 GB ,可以使用简单复制(https://cloud.tencent.com/document/product/436/14117).
当复制对象超过 5 GB 时,必须使用分块复制(https://cloud.tencent.com/document/product/436/14118 )
来实现复制.
API 接口:https://cloud.tencent.com/document/product/436/10881.
SDK 示例:简单对象复制示例
request
- 简单复制对象请求 CopyObjectRequest
CopyObjectResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void copyObjectAsync(CopyObjectRequest request, CosXmlResultListener cosXmlResultListener)
简单复制对象的异步方法.
COS 中复制对象可以完成如下功能:
当复制的对象小于等于 5 GB ,可以使用简单复制(https://cloud.tencent.com/document/product/436/14117).
当复制对象超过 5 GB 时,必须使用分块复制(https://cloud.tencent.com/document/product/436/14118 )
来实现复制.
API 接口:https://cloud.tencent.com/document/product/436/10881.
SDK 示例:简单对象复制示例
request
- 简单复制对象请求 CopyObjectRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
UploadPartCopyResult copyObject(UploadPartCopyRequest request) throws CosXmlClientException, CosXmlServiceException
分块复制的同步方法.
COS 中复制对象可以完成如下功能:
当复制的对象小于等于 5 GB ,可以使用简单复制(https://cloud.tencent.com/document/product/436/14117).
当复制对象超过 5 GB 时,必须使用分块复制(https://cloud.tencent.com/document/product/436/14118 )
来实现复制.
API 接口:https://cloud.tencent.com/document/product/436/8287.
SDK 示例:分块复制示例
request
- 分块复制请求 UploadPartCopyRequest
UploadPartCopyResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void copyObjectAsync(UploadPartCopyRequest request, CosXmlResultListener cosXmlResultListener)
分块复制的异步方法.
COS 中复制对象可以完成如下功能:
当复制的对象小于等于 5 GB ,可以使用简单复制(https://cloud.tencent.com/document/product/436/14117).
当复制对象超过 5 GB 时,必须使用分块复制(https://cloud.tencent.com/document/product/436/14118 )
来实现复制.
API 接口:https://cloud.tencent.com/document/product/436/8287.
SDK 示例:分块复制示例
request
- 分块复制请求 UploadPartCopyRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
InitMultipartUploadResult initMultipartUpload(InitMultipartUploadRequest request) throws CosXmlClientException, CosXmlServiceException
初始化分块上传的同步方法.
使用分块上传对象时,首先要进行初始化分片上传操作,获取对应分块上传的 uploadId,用于后续上传操
作.分块上传适合于在弱网络或高带宽环境下上传较大的对象.SDK 支持自行切分对象并分别调用BaseCosXml.uploadPart(UploadPartRequest)
或者BaseCosXml.uploadPartAsync(UploadPartRequest, CosXmlResultListener)
上传各
个分块.
功能描述:https://cloud.tencent.com/document/product/436/14112.
API 接口:https://cloud.tencent.com/document/product/436/7746.
SDK 示例:初始化分块上传示例
request
- 初始化分块上传请求 InitMultipartUploadRequest
InitMultipartUploadResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void initMultipartUploadAsync(InitMultipartUploadRequest request, CosXmlResultListener cosXmlResultListener)
初始化分块上传的异步方法.
使用分块上传对象时,首先要进行初始化分片上传操作,获取对应分块上传的 uploadId,用于后续上传操
作.分块上传适合于在弱网络或高带宽环境下上传较大的对象.SDK 支持自行切分对象并分别调用BaseCosXml.uploadPart(UploadPartRequest)
或者BaseCosXml.uploadPartAsync(UploadPartRequest, CosXmlResultListener)
上传各
个分块.
功能描述:https://cloud.tencent.com/document/product/436/14112.
API 接口:https://cloud.tencent.com/document/product/436/7746.
SDK 示例:初始化分块上传示例
request
- 初始化分块上传请求 InitMultipartUploadRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
ListPartsResult listParts(ListPartsRequest request) throws CosXmlClientException, CosXmlServiceException
查询特定分块上传中的已上传的块的同步方法.
COS 支持查询特定分块上传中的已上传的块, 即可以 罗列出指定 UploadId 所属的所有已上传成功的分块. 因此,基于此可以完成续传功能.
功能描述:https://cloud.tencent.com/document/product/436/14112,
API 接口:https://cloud.tencent.com/document/product/436/7747.
SDK 示例:查询已上传块示例
request
- 查询特定分块上传中的已上传块请求 ListPartsRequest
ListPartsResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void listPartsAsync(ListPartsRequest request, CosXmlResultListener cosXmlResultListener)
查询特定分块上传中的已上传的块的异步方法.
COS 支持查询特定分块上传中的已上传的块, 即可以 罗列出指定 UploadId 所属的所有已上传成功的分块. 因此,基于此可以完成续传功能.
功能描述:https://cloud.tencent.com/document/product/436/14112,
API 接口:https://cloud.tencent.com/document/product/436/7747.
SDK 示例:查询已上传块示例
request
- 查询特定分块上传中已上传的块请求 ListPartsRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
AbortMultiUploadResult abortMultiUpload(AbortMultiUploadRequest request) throws CosXmlClientException, CosXmlServiceException
终止一个分块上传操作并删除已上传的块的同步方法.
COS 支持终止一个分块上传操作并删除已上传的块. 注意,已上传但是未终止的分片块会占用存储空间进 而产生存储费用.因此,建议及时完成分块上传 或者终止分块上传.
功能描述:https://cloud.tencent.com/document/product/436/14112.
API 接口:https://cloud.tencent.com/document/product/436/7740.
SDK 示例:终止分块上传示例
request
- 终止一个分块上传且删除已上传的分片块请求 AbortMultiUploadRequest
AbortMultiUploadResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void abortMultiUploadAsync(AbortMultiUploadRequest request, CosXmlResultListener cosXmlResultListener)
终止一个分块上传操作并删除已上传的块的异步方法.
COS 支持终止一个分块上传操作并删除已上传的块. 注意,已上传但是未终止的分片块会占用存储空间进 而产生存储费用.因此,建议及时完成分块上传 或者终止分块上传.
功能描述:https://cloud.tencent.com/document/product/436/14112.
API 接口:https://cloud.tencent.com/document/product/436/7740.
SDK 示例:终止分块上传示例
request
- 终止一个分块上传且删除已上传的分片块请求 AbortMultiUploadRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
CompleteMultiUploadResult completeMultiUpload(CompleteMultiUploadRequest request) throws CosXmlClientException, CosXmlServiceException
完成整个分块上传的同步方法.
当使用分块上传(BaseCosXml.uploadPart(UploadPartRequest)
)完对象的所有块以后,必须调用该 completeMultiUpload(CompleteMultiUploadRequest)
或者 completeMultiUploadAsync(CompleteMultiUploadRequest, CosXmlResultListener)
来完成整个文件的分块上传.且在该请求的 Body 中需要给出每一个块的 PartNumber 和 ETag,用来校验块的准
确性.
分块上传适合于在弱网络或高带宽环境下上传较大的对象.SDK 支持自行切分对象并分别调用BaseCosXml.uploadPart(UploadPartRequest)
上传各
个分块.
功能描述:https://cloud.tencent.com/document/product/436/14112.
API 接口:https://cloud.tencent.com/document/product/436/7742.
SDK 示例:完成分块上传示例
request
- 完成整个分块上传请求 CompleteMultiUploadRequest
CompleteMultiUploadResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void completeMultiUploadAsync(CompleteMultiUploadRequest request, CosXmlResultListener cosXmlResultListener)
完成整个分块上传的异步方法.
当使用分块上传(BaseCosXml.uploadPart(UploadPartRequest)
)完对象的所有块以后,必须调用该 completeMultiUpload(CompleteMultiUploadRequest)
或者 completeMultiUploadAsync(CompleteMultiUploadRequest, CosXmlResultListener)
来完成整个文件的分块上传.且在该请求的 Body 中需要给出每一个块的 PartNumber 和 ETag,用来校验块的准
确性.
分块上传适合于在弱网络或高带宽环境下上传较大的对象.SDK 支持自行切分对象并分别调用BaseCosXml.uploadPart(UploadPartRequest)
上传各
个分块.
功能描述:https://cloud.tencent.com/document/product/436/14112.
API 接口:https://cloud.tencent.com/document/product/436/7742.
SDK 示例:完成分块上传示例
request
- 初始化分片请求 CompleteMultiUploadRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
ListMultiUploadsResult listMultiUploads(ListMultiUploadsRequest request) throws CosXmlClientException, CosXmlServiceException
查询存储桶(Bucket)中正在进行中的分块上传对象的同步方法.
COS 支持查询 Bucket 中有哪些正在进行中的分块上传对象,单次请求操作最多列出 1000 个正在进行中的 分块上传对象.
API 接口:
https://cloud.tencent.com/document/product/436/7736.
SDK 示例:查询分块上传示例
request
- 查询 Bucket 中正在进行中的分块上传对象请求 ListMultiUploadsRequest
ListMultiUploadsResult
CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void listMultiUploadsAsync(ListMultiUploadsRequest request, CosXmlResultListener cosXmlResultListener)
查询存储桶(Bucket)中正在进行中的分块上传对象的异步方法.
COS 支持查询 Bucket 中有哪些正在进行中的分块上传对象,单次请求操作最多列出 1000 个正在进行中的 分块上传对象.
API 接口:https://cloud.tencent.com/document/product/436/7736.
SDK 示例:查询分块上传示例
request
- 查询 Bucket 中正在进行中的分块上传对象请求 ListMultiUploadsRequest
cosXmlResultListener
- 请求回调结果 CosXmlResultListener
boolean preBuildConnection(java.lang.String bucket) throws CosXmlClientException, CosXmlServiceException
预连接的同步方法。
bucket
- bucket 名称, 如 test-1250000000CosXmlClientException
- 客户端异常CosXmlServiceException
- 服务端异常void preBuildConnectionAsync(java.lang.String bucket, CosXmlResultSimpleListener listener)
预连接的异步方法。
bucket
- bucket 名称, 如 test-1250000000listener
- 结果回调函数