QCloudPutObjectCopyRequest.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. //
  2. // PutObjectCopy.h
  3. // PutObjectCopy
  4. //
  5. // Created by tencent
  6. // Copyright (c) 2015年 tencent. All rights reserved.
  7. //
  8. // ██████╗ ██████╗██╗ ██████╗ ██╗ ██╗██████╗ ████████╗███████╗██████╗ ███╗ ███╗██╗███╗ ██╗ █████╗ ██╗ ██╗ █████╗ ██████╗
  9. // ██╔═══██╗██╔════╝██║ ██╔═══██╗██║ ██║██╔══██╗ ╚══██╔══╝██╔════╝██╔══██╗████╗ ████║██║████╗ ██║██╔══██╗██║ ██║ ██╔══██╗██╔══██╗
  10. // ██║ ██║██║ ██║ ██║ ██║██║ ██║██║ ██║ ██║ █████╗ ██████╔╝██╔████╔██║██║██╔██╗ ██║███████║██║ ██║ ███████║██████╔╝
  11. // ██║▄▄ ██║██║ ██║ ██║ ██║██║ ██║██║ ██║ ██║ ██╔══╝ ██╔══██╗██║╚██╔╝██║██║██║╚██╗██║██╔══██║██║ ██║ ██╔══██║██╔══██╗
  12. // ╚██████╔╝╚██████╗███████╗╚██████╔╝╚██████╔╝██████╔╝ ██║ ███████╗██║ ██║██║ ╚═╝ ██║██║██║ ╚████║██║ ██║███████╗ ███████╗██║ ██║██████╔╝
  13. // ╚══▀▀═╝ ╚═════╝╚══════╝ ╚═════╝ ╚═════╝ ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝╚═╝ ╚═══╝╚═╝ ╚═╝╚══════╝ ╚══════╝╚═╝ ╚═╝╚═════╝
  14. //
  15. //
  16. // _ __ _ _
  17. // (_) / _| | | | |
  18. // ___ ___ _ ____ ___ ___ ___ | |_ ___ _ __ __| | _____ _____| | ___ _ __ ___ _ __ ___
  19. // / __|/ _ \ '__\ \ / / |/ __/ _ \ | _/ _ \| '__| / _` |/ _ \ \ / / _ \ |/ _ \| '_ \ / _ \ '__/ __|
  20. // \__ \ __/ | \ V /| | (_| __/ | || (_) | | | (_| | __/\ V / __/ | (_) | |_) | __/ | \__
  21. // |___/\___|_| \_/ |_|\___\___| |_| \___/|_| \__,_|\___| \_/ \___|_|\___/| .__/ \___|_| |___/
  22. // ______ ______ ______ ______ ______ ______ ______ ______ | |
  23. // |______|______|______|______|______|______|______|______| |_|
  24. //
  25. #import <Foundation/Foundation.h>
  26. #import <QCloudCore/QCloudCore.h>
  27. #import "QCloudCopyObjectResult.h"
  28. #import "QCloudCOSStorageClassEnum.h"
  29. NS_ASSUME_NONNULL_BEGIN
  30. /**
  31. 简单复制对象的方法.
  32. COS 中复制对象可以完成如下功能:
  33. 创建一个新的对象副本.
  34. 复制对象并更名,删除原始对象,实现重命名
  35. 修改对象的存储类型,在复制时选择相同的源和目标对象键,修改存储类型.
  36. 在不同的腾讯云 COS 地域复制对象.
  37. 修改对象的元数据,在复制时选择相同的源和目标对象键,并修改其中的元数据,复制对象时,默认将继承原对象的元数据,但创建日期将会按新对象的时间计算.
  38. 当复制的对象小于等于 5 GB ,可以使用简单复制(https://cloud.tencent.com/document/product/436/14117).
  39. 当复制对象超过 5 GB 时,必须使用分块复制(https://cloud.tencent.com/document/product/436/14118 ) 来实现复制.
  40. 关于简单复制接口的具体描述,请查看https://cloud.tencent.com/document/product/436/10881.
  41. cos iOS SDK 中简单复制对象的方法具体步骤如下:
  42. 1. 实例化 QCloudPutObjectCopyRequest,填入需要的参数。
  43. 2. 调用 QCloudCOSXMLService 对象中的 PutObjectCopy 方法发出请求。
  44. 3. 从回调的 finishBlock 中的 QCloudCopyObjectResult 获取具体内容。
  45. 示例:
  46. @code
  47. QCloudPutObjectCopyRequest* request = [[QCloudPutObjectCopyRequest alloc] init];
  48. request.bucket = @"bucketName";
  49. request.object = @"objectName";
  50. request.objectCopySource = @"objectCopySource";
  51. [request setFinishBlock:^(QCloudCopyObjectResult* result, NSError* error) {
  52. }];
  53. [[QCloudCOSXMLService defaultCOSXML] PutObjectCopy:request];
  54. @endcode
  55. */
  56. @interface QCloudPutObjectCopyRequest : QCloudBizHTTPRequest
  57. /**
  58. 对象名
  59. */
  60. @property (strong, nonatomic) NSString *object;
  61. /**
  62. 存储桶名
  63. */
  64. @property (strong, nonatomic) NSString *bucket;
  65. /**
  66. 源文件 URL 路径,可以通过 versionid 子资源指定历史版本
  67. */
  68. @property (strong, nonatomic) NSString *objectCopySource;
  69. /**
  70. 是否拷贝元数据,枚举值:Copy, Replaced,默认值 Copy。假如标记为 Copy,忽略 Header 中的用户元数据信息直接复制;假如标记为 Replaced,按 Header 信息修改元数据。当目标路径和原路径一致,即用户试图修改元数据时,必须为 Replaced
  71. */
  72. @property (strong, nonatomic) NSString *metadataDirective;
  73. /**
  74. 当 Object 在指定时间后被修改,则执行操作,否则返回 412。可与 x-cos-copy-source-If-None-Match 一起使用,与其他条件联合使用返回冲突。
  75. */
  76. @property (strong, nonatomic) NSString *objectCopyIfModifiedSince;
  77. /**
  78. 当 Object 在指定时间后未被修改,则执行操作,否则返回 412。可与 x-cos-copy-source-If-Match 一起使用,与其他条件联合使用返回冲突。
  79. */
  80. @property (strong, nonatomic) NSString *objectCopyIfUnmodifiedSince;
  81. /**
  82. 当 Object 的 Etag 和给定一致时,则执行操作,否则返回 412。可与x-cos-copy-source-If-Unmodified-Since 一起使用,与其他条件联合使用返回冲突。
  83. */
  84. @property (strong, nonatomic) NSString *objectCopyIfMatch;
  85. /**
  86. 当 Object 的 Etag 和给定不一致时,则执行操作,否则返回 412。可与 x-cos-copy-source-If-Modified-Since 一起使用,与其他条件联合使用返回冲突。
  87. */
  88. @property (strong, nonatomic) NSString *objectCopyIfNoneMatch;
  89. /**
  90. Object 的存储级别
  91. */
  92. @property (assign, nonatomic) QCloudCOSStorageClass storageClass;
  93. /**
  94. 定义 Object 的 ACL 属性。有效值:private,public-read-write,public-read;默认值:private
  95. */
  96. @property (strong, nonatomic) NSString *accessControlList;
  97. /**
  98. 赋予被授权者读的权限。格式:id=" ",id=" ";
  99. 当需要给子账户授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>",
  100. 当需要给根账户授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>"
  101. */
  102. @property (strong, nonatomic) NSString *grantRead;
  103. /**
  104. 赋予被授权者写的权限。格式:id=" ",id=" ";
  105. 当需要给子账户授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>",
  106. 当需要给根账户授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>"
  107. */
  108. @property (strong, nonatomic) NSString *grantWrite;
  109. /**
  110. 赋予被授权者读写权限。格式: id=" ",id=" " ;
  111. 当需要给子账户授权时,id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>",
  112. 当需要给根账户授权时,id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>"
  113. */
  114. @property (strong, nonatomic) NSString *grantFullControl;
  115. /**
  116. 指定源文件的versionID
  117. */
  118. @property (strong, nonatomic) NSString *versionID;
  119. /*
  120. 在进行HTTP请求的时候,可以通过设置该参数来设置自定义的一些头部信息。
  121. 通常情况下,携带特定的额外HTTP头部可以使用某项功能,如果是这类需求,可以通过设置该属性来实现。
  122. */
  123. @property (strong, nonatomic) NSDictionary* customHeaders;
  124. - (void) setFinishBlock:(void (^)(QCloudCopyObjectResult* result, NSError * error))QCloudRequestFinishBlock;
  125. @end
  126. NS_ASSUME_NONNULL_END