huaweicloudsdkobs 3.1.142__py2.py3-none-any.whl → 3.1.143__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. huaweicloudsdkobs/v1/model/access_control_list.py +3 -3
  2. huaweicloudsdkobs/v1/model/bucket.py +11 -11
  3. huaweicloudsdkobs/v1/model/buckets.py +3 -3
  4. huaweicloudsdkobs/v1/model/common_prefixes.py +3 -3
  5. huaweicloudsdkobs/v1/model/contents.py +15 -15
  6. huaweicloudsdkobs/v1/model/copy_object_request.py +53 -53
  7. huaweicloudsdkobs/v1/model/copy_object_response.py +29 -29
  8. huaweicloudsdkobs/v1/model/create_bucket_request.py +37 -37
  9. huaweicloudsdkobs/v1/model/create_bucket_request_body.py +3 -3
  10. huaweicloudsdkobs/v1/model/create_bucket_response.py +13 -13
  11. huaweicloudsdkobs/v1/model/delete_bucket_customdomain_request.py +7 -7
  12. huaweicloudsdkobs/v1/model/delete_bucket_customdomain_response.py +13 -13
  13. huaweicloudsdkobs/v1/model/delete_bucket_request.py +5 -5
  14. huaweicloudsdkobs/v1/model/delete_bucket_response.py +13 -13
  15. huaweicloudsdkobs/v1/model/delete_object.py +5 -5
  16. huaweicloudsdkobs/v1/model/delete_object_request.py +9 -9
  17. huaweicloudsdkobs/v1/model/delete_object_response.py +17 -17
  18. huaweicloudsdkobs/v1/model/delete_objects_request.py +11 -11
  19. huaweicloudsdkobs/v1/model/delete_objects_request_body.py +7 -7
  20. huaweicloudsdkobs/v1/model/delete_objects_response.py +19 -19
  21. huaweicloudsdkobs/v1/model/delete_result_deleted.py +9 -9
  22. huaweicloudsdkobs/v1/model/delete_result_error.py +7 -7
  23. huaweicloudsdkobs/v1/model/domains.py +7 -7
  24. huaweicloudsdkobs/v1/model/filter_object.py +3 -3
  25. huaweicloudsdkobs/v1/model/filter_rule.py +5 -5
  26. huaweicloudsdkobs/v1/model/function_stage_configuration.py +11 -11
  27. huaweicloudsdkobs/v1/model/get_bucket_acl_request.py +7 -7
  28. huaweicloudsdkobs/v1/model/get_bucket_acl_response.py +17 -17
  29. huaweicloudsdkobs/v1/model/get_bucket_customdomain_request.py +7 -7
  30. huaweicloudsdkobs/v1/model/get_bucket_customdomain_response.py +15 -15
  31. huaweicloudsdkobs/v1/model/get_bucket_metadata_request.py +9 -9
  32. huaweicloudsdkobs/v1/model/get_bucket_metadata_response.py +37 -37
  33. huaweicloudsdkobs/v1/model/get_bucket_notification_request.py +7 -7
  34. huaweicloudsdkobs/v1/model/get_bucket_notification_response.py +15 -15
  35. huaweicloudsdkobs/v1/model/get_object_metadata_request.py +23 -23
  36. huaweicloudsdkobs/v1/model/get_object_metadata_response.py +49 -49
  37. huaweicloudsdkobs/v1/model/get_object_request.py +41 -41
  38. huaweicloudsdkobs/v1/model/get_object_response.py +33 -33
  39. huaweicloudsdkobs/v1/model/grant.py +7 -7
  40. huaweicloudsdkobs/v1/model/grantee.py +5 -5
  41. huaweicloudsdkobs/v1/model/list_buckets_request.py +5 -5
  42. huaweicloudsdkobs/v1/model/list_buckets_response.py +19 -19
  43. huaweicloudsdkobs/v1/model/list_objects_request.py +19 -19
  44. huaweicloudsdkobs/v1/model/list_objects_response.py +35 -35
  45. huaweicloudsdkobs/v1/model/owner.py +3 -3
  46. huaweicloudsdkobs/v1/model/put_object_request.py +41 -41
  47. huaweicloudsdkobs/v1/model/put_object_response.py +25 -25
  48. huaweicloudsdkobs/v1/model/set_bucket_acl_request.py +11 -11
  49. huaweicloudsdkobs/v1/model/set_bucket_acl_request_body.py +5 -5
  50. huaweicloudsdkobs/v1/model/set_bucket_acl_response.py +13 -13
  51. huaweicloudsdkobs/v1/model/set_bucket_custom_domain_body.py +11 -11
  52. huaweicloudsdkobs/v1/model/set_bucket_customedomain_request.py +9 -9
  53. huaweicloudsdkobs/v1/model/set_bucket_customedomain_response.py +13 -13
  54. huaweicloudsdkobs/v1/model/set_bucket_notification_request.py +9 -9
  55. huaweicloudsdkobs/v1/model/set_bucket_notification_request_body.py +5 -5
  56. huaweicloudsdkobs/v1/model/set_bucket_notification_response.py +13 -13
  57. huaweicloudsdkobs/v1/model/topic_configuration.py +9 -9
  58. huaweicloudsdkobs/v1/model/topic_configuration_filter.py +3 -3
  59. huaweicloudsdkobs/v1/obs_async_client.py +18 -18
  60. huaweicloudsdkobs/v1/obs_client.py +18 -18
  61. {huaweicloudsdkobs-3.1.142.dist-info → huaweicloudsdkobs-3.1.143.dist-info}/METADATA +2 -2
  62. huaweicloudsdkobs-3.1.143.dist-info/RECORD +72 -0
  63. huaweicloudsdkobs-3.1.142.dist-info/RECORD +0 -72
  64. {huaweicloudsdkobs-3.1.142.dist-info → huaweicloudsdkobs-3.1.143.dist-info}/LICENSE +0 -0
  65. {huaweicloudsdkobs-3.1.142.dist-info → huaweicloudsdkobs-3.1.143.dist-info}/WHEEL +0 -0
  66. {huaweicloudsdkobs-3.1.142.dist-info → huaweicloudsdkobs-3.1.143.dist-info}/top_level.txt +0 -0
@@ -77,7 +77,7 @@ class CopyObjectRequest:
77
77
  }
78
78
 
79
79
  def __init__(self, date=None, bucket_name=None, object_key=None, x_obs_acl=None, x_obs_grant_read=None, x_obs_grant_read_acp=None, x_obs_grant_write_acp=None, x_obs_grant_full_control=None, x_obs_copy_source=None, x_obs_metadata_directive=None, x_obs_copy_source_if_match=None, x_obs_copy_source_if_none_match=None, x_obs_copy_source_if_unmodified_since=None, x_obs_copy_source_if_modified_since=None, x_obs_storage_class=None, x_obs_persistent_headers=None, x_obs_website_redirect_location=None, x_obs_server_side_encryption=None, x_obs_server_side_encryption_kms_key_id=None, x_obs_server_side_encryption_customer_algorithm=None, x_obs_server_side_encryption_customer_key=None, x_obs_server_side_encryption_customer_key_md5=None, x_obs_copy_source_server_side_encryption_customer_algorithm=None, x_obs_copy_source_server_side_encryption_customer_key=None, x_obs_copy_source_server_side_encryption_customer_key_md5=None, success_action_redirect=None):
80
- """CopyObjectRequest
80
+ r"""CopyObjectRequest
81
81
 
82
82
  The model defined in huaweicloud sdk
83
83
 
@@ -217,7 +217,7 @@ class CopyObjectRequest:
217
217
 
218
218
  @property
219
219
  def date(self):
220
- """Gets the date of this CopyObjectRequest.
220
+ r"""Gets the date of this CopyObjectRequest.
221
221
 
222
222
  Time when a request was initiated, for example, **Wed, 27 Jun 2018 13:39:15 +0000**. Default value: none Restriction: This header is optional if the **x-obs-date** header is contained in the request, but mandatory in other circumstances.
223
223
 
@@ -228,7 +228,7 @@ class CopyObjectRequest:
228
228
 
229
229
  @date.setter
230
230
  def date(self, date):
231
- """Sets the date of this CopyObjectRequest.
231
+ r"""Sets the date of this CopyObjectRequest.
232
232
 
233
233
  Time when a request was initiated, for example, **Wed, 27 Jun 2018 13:39:15 +0000**. Default value: none Restriction: This header is optional if the **x-obs-date** header is contained in the request, but mandatory in other circumstances.
234
234
 
@@ -239,7 +239,7 @@ class CopyObjectRequest:
239
239
 
240
240
  @property
241
241
  def bucket_name(self):
242
- """Gets the bucket_name of this CopyObjectRequest.
242
+ r"""Gets the bucket_name of this CopyObjectRequest.
243
243
 
244
244
  Name of the requested bucket
245
245
 
@@ -250,7 +250,7 @@ class CopyObjectRequest:
250
250
 
251
251
  @bucket_name.setter
252
252
  def bucket_name(self, bucket_name):
253
- """Sets the bucket_name of this CopyObjectRequest.
253
+ r"""Sets the bucket_name of this CopyObjectRequest.
254
254
 
255
255
  Name of the requested bucket
256
256
 
@@ -261,7 +261,7 @@ class CopyObjectRequest:
261
261
 
262
262
  @property
263
263
  def object_key(self):
264
- """Gets the object_key of this CopyObjectRequest.
264
+ r"""Gets the object_key of this CopyObjectRequest.
265
265
 
266
266
  Name of the object copy.
267
267
 
@@ -272,7 +272,7 @@ class CopyObjectRequest:
272
272
 
273
273
  @object_key.setter
274
274
  def object_key(self, object_key):
275
- """Sets the object_key of this CopyObjectRequest.
275
+ r"""Sets the object_key of this CopyObjectRequest.
276
276
 
277
277
  Name of the object copy.
278
278
 
@@ -283,7 +283,7 @@ class CopyObjectRequest:
283
283
 
284
284
  @property
285
285
  def x_obs_acl(self):
286
- """Gets the x_obs_acl of this CopyObjectRequest.
286
+ r"""Gets the x_obs_acl of this CopyObjectRequest.
287
287
 
288
288
  When copying the object, you can add this header to configure access control policies for the object. The frequently used predefined policies include **private**, **public-read**, and **public-read-write**. For more information, see the ACL configuration using header fields in the ACLs section. Example: x-obs-acl: acl
289
289
 
@@ -294,7 +294,7 @@ class CopyObjectRequest:
294
294
 
295
295
  @x_obs_acl.setter
296
296
  def x_obs_acl(self, x_obs_acl):
297
- """Sets the x_obs_acl of this CopyObjectRequest.
297
+ r"""Sets the x_obs_acl of this CopyObjectRequest.
298
298
 
299
299
  When copying the object, you can add this header to configure access control policies for the object. The frequently used predefined policies include **private**, **public-read**, and **public-read-write**. For more information, see the ACL configuration using header fields in the ACLs section. Example: x-obs-acl: acl
300
300
 
@@ -305,7 +305,7 @@ class CopyObjectRequest:
305
305
 
306
306
  @property
307
307
  def x_obs_grant_read(self):
308
- """Gets the x_obs_grant_read of this CopyObjectRequest.
308
+ r"""Gets the x_obs_grant_read of this CopyObjectRequest.
309
309
 
310
310
  When creating an object, you can use this header to grant all users in a domain the permissions to read the object and obtain object metadata.
311
311
 
@@ -316,7 +316,7 @@ class CopyObjectRequest:
316
316
 
317
317
  @x_obs_grant_read.setter
318
318
  def x_obs_grant_read(self, x_obs_grant_read):
319
- """Sets the x_obs_grant_read of this CopyObjectRequest.
319
+ r"""Sets the x_obs_grant_read of this CopyObjectRequest.
320
320
 
321
321
  When creating an object, you can use this header to grant all users in a domain the permissions to read the object and obtain object metadata.
322
322
 
@@ -327,7 +327,7 @@ class CopyObjectRequest:
327
327
 
328
328
  @property
329
329
  def x_obs_grant_read_acp(self):
330
- """Gets the x_obs_grant_read_acp of this CopyObjectRequest.
330
+ r"""Gets the x_obs_grant_read_acp of this CopyObjectRequest.
331
331
 
332
332
  When creating an object, you can use this header to grant all users in a domain the permissions to obtain the object ACL.
333
333
 
@@ -338,7 +338,7 @@ class CopyObjectRequest:
338
338
 
339
339
  @x_obs_grant_read_acp.setter
340
340
  def x_obs_grant_read_acp(self, x_obs_grant_read_acp):
341
- """Sets the x_obs_grant_read_acp of this CopyObjectRequest.
341
+ r"""Sets the x_obs_grant_read_acp of this CopyObjectRequest.
342
342
 
343
343
  When creating an object, you can use this header to grant all users in a domain the permissions to obtain the object ACL.
344
344
 
@@ -349,7 +349,7 @@ class CopyObjectRequest:
349
349
 
350
350
  @property
351
351
  def x_obs_grant_write_acp(self):
352
- """Gets the x_obs_grant_write_acp of this CopyObjectRequest.
352
+ r"""Gets the x_obs_grant_write_acp of this CopyObjectRequest.
353
353
 
354
354
  When creating an object, you can use this header to grant all users in a domain the permissions to write the object ACL.
355
355
 
@@ -360,7 +360,7 @@ class CopyObjectRequest:
360
360
 
361
361
  @x_obs_grant_write_acp.setter
362
362
  def x_obs_grant_write_acp(self, x_obs_grant_write_acp):
363
- """Sets the x_obs_grant_write_acp of this CopyObjectRequest.
363
+ r"""Sets the x_obs_grant_write_acp of this CopyObjectRequest.
364
364
 
365
365
  When creating an object, you can use this header to grant all users in a domain the permissions to write the object ACL.
366
366
 
@@ -371,7 +371,7 @@ class CopyObjectRequest:
371
371
 
372
372
  @property
373
373
  def x_obs_grant_full_control(self):
374
- """Gets the x_obs_grant_full_control of this CopyObjectRequest.
374
+ r"""Gets the x_obs_grant_full_control of this CopyObjectRequest.
375
375
 
376
376
  When creating an object, you can use this header to grant all users in a domain the permissions to read the object, to obtain the object metadata and ACL, and to write the object ACL.
377
377
 
@@ -382,7 +382,7 @@ class CopyObjectRequest:
382
382
 
383
383
  @x_obs_grant_full_control.setter
384
384
  def x_obs_grant_full_control(self, x_obs_grant_full_control):
385
- """Sets the x_obs_grant_full_control of this CopyObjectRequest.
385
+ r"""Sets the x_obs_grant_full_control of this CopyObjectRequest.
386
386
 
387
387
  When creating an object, you can use this header to grant all users in a domain the permissions to read the object, to obtain the object metadata and ACL, and to write the object ACL.
388
388
 
@@ -393,7 +393,7 @@ class CopyObjectRequest:
393
393
 
394
394
  @property
395
395
  def x_obs_copy_source(self):
396
- """Gets the x_obs_copy_source of this CopyObjectRequest.
396
+ r"""Gets the x_obs_copy_source of this CopyObjectRequest.
397
397
 
398
398
  Indicates names of the source bucket and object in a copy request. If the source object has multiple versions, use the **versionId** parameter to specify an object version. Restriction: URL encoding is required for handling Chinese characters. Example: x-obs-copy-source: /source_bucket/sourceObject
399
399
 
@@ -404,7 +404,7 @@ class CopyObjectRequest:
404
404
 
405
405
  @x_obs_copy_source.setter
406
406
  def x_obs_copy_source(self, x_obs_copy_source):
407
- """Sets the x_obs_copy_source of this CopyObjectRequest.
407
+ r"""Sets the x_obs_copy_source of this CopyObjectRequest.
408
408
 
409
409
  Indicates names of the source bucket and object in a copy request. If the source object has multiple versions, use the **versionId** parameter to specify an object version. Restriction: URL encoding is required for handling Chinese characters. Example: x-obs-copy-source: /source_bucket/sourceObject
410
410
 
@@ -415,7 +415,7 @@ class CopyObjectRequest:
415
415
 
416
416
  @property
417
417
  def x_obs_metadata_directive(self):
418
- """Gets the x_obs_metadata_directive of this CopyObjectRequest.
418
+ r"""Gets the x_obs_metadata_directive of this CopyObjectRequest.
419
419
 
420
420
  Indicates whether the metadata of the target object is copied from the source object or replaced with the metadata provided in the request. Valid values: **COPY** and **REPLACE** Default value: **COPY** Example: x-obs-metadata-directive: metadata_directive Restriction: Values other than **COPY** or **REPLACE** result in an immediate 400-based error response. If you need to modify the metadata (for both the source and target objects), this parameter must be set to **REPLACE**, otherwise, the request is invalid and the server returns a 400 error. This parameter cannot change an encrypted object to a non-encrypted one (for both the source and target objects). If you use this parameter to change the encrypted object, OBS returns a 400 error.
421
421
 
@@ -426,7 +426,7 @@ class CopyObjectRequest:
426
426
 
427
427
  @x_obs_metadata_directive.setter
428
428
  def x_obs_metadata_directive(self, x_obs_metadata_directive):
429
- """Sets the x_obs_metadata_directive of this CopyObjectRequest.
429
+ r"""Sets the x_obs_metadata_directive of this CopyObjectRequest.
430
430
 
431
431
  Indicates whether the metadata of the target object is copied from the source object or replaced with the metadata provided in the request. Valid values: **COPY** and **REPLACE** Default value: **COPY** Example: x-obs-metadata-directive: metadata_directive Restriction: Values other than **COPY** or **REPLACE** result in an immediate 400-based error response. If you need to modify the metadata (for both the source and target objects), this parameter must be set to **REPLACE**, otherwise, the request is invalid and the server returns a 400 error. This parameter cannot change an encrypted object to a non-encrypted one (for both the source and target objects). If you use this parameter to change the encrypted object, OBS returns a 400 error.
432
432
 
@@ -437,7 +437,7 @@ class CopyObjectRequest:
437
437
 
438
438
  @property
439
439
  def x_obs_copy_source_if_match(self):
440
- """Gets the x_obs_copy_source_if_match of this CopyObjectRequest.
440
+ r"""Gets the x_obs_copy_source_if_match of this CopyObjectRequest.
441
441
 
442
442
  Copies the source object only if its ETag matches the one specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. Example: x-obs-copy-source-if-match: etag Restriction: This parameter can be used with **x-obs-copy-source-if-unmodified-since** but not other conditional copy parameters.
443
443
 
@@ -448,7 +448,7 @@ class CopyObjectRequest:
448
448
 
449
449
  @x_obs_copy_source_if_match.setter
450
450
  def x_obs_copy_source_if_match(self, x_obs_copy_source_if_match):
451
- """Sets the x_obs_copy_source_if_match of this CopyObjectRequest.
451
+ r"""Sets the x_obs_copy_source_if_match of this CopyObjectRequest.
452
452
 
453
453
  Copies the source object only if its ETag matches the one specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. Example: x-obs-copy-source-if-match: etag Restriction: This parameter can be used with **x-obs-copy-source-if-unmodified-since** but not other conditional copy parameters.
454
454
 
@@ -459,7 +459,7 @@ class CopyObjectRequest:
459
459
 
460
460
  @property
461
461
  def x_obs_copy_source_if_none_match(self):
462
- """Gets the x_obs_copy_source_if_none_match of this CopyObjectRequest.
462
+ r"""Gets the x_obs_copy_source_if_none_match of this CopyObjectRequest.
463
463
 
464
464
  Copies the object only if its ETag does not match the one specified in this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. Example: x-obs-copy-source-if-none-match: etag Restriction: This parameter can be used with **x-obs-copy-source-if-modified-since** but not other conditional copy parameters.
465
465
 
@@ -470,7 +470,7 @@ class CopyObjectRequest:
470
470
 
471
471
  @x_obs_copy_source_if_none_match.setter
472
472
  def x_obs_copy_source_if_none_match(self, x_obs_copy_source_if_none_match):
473
- """Sets the x_obs_copy_source_if_none_match of this CopyObjectRequest.
473
+ r"""Sets the x_obs_copy_source_if_none_match of this CopyObjectRequest.
474
474
 
475
475
  Copies the object only if its ETag does not match the one specified in this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. Example: x-obs-copy-source-if-none-match: etag Restriction: This parameter can be used with **x-obs-copy-source-if-modified-since** but not other conditional copy parameters.
476
476
 
@@ -481,7 +481,7 @@ class CopyObjectRequest:
481
481
 
482
482
  @property
483
483
  def x_obs_copy_source_if_unmodified_since(self):
484
- """Gets the x_obs_copy_source_if_unmodified_since of this CopyObjectRequest.
484
+ r"""Gets the x_obs_copy_source_if_unmodified_since of this CopyObjectRequest.
485
485
 
486
486
  Copies the source object only if it has not been modified since the time specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. This header can be used with **x-obs-copy-source-if-match**, but cannot be used with other conditional copy headers. Type: HTTP time string complying with the format specified at **http://www.ietf.org/rfc/rfc2616.txt** Example: x-obs-copy-source-if-unmodified -since: time-sta
487
487
 
@@ -492,7 +492,7 @@ class CopyObjectRequest:
492
492
 
493
493
  @x_obs_copy_source_if_unmodified_since.setter
494
494
  def x_obs_copy_source_if_unmodified_since(self, x_obs_copy_source_if_unmodified_since):
495
- """Sets the x_obs_copy_source_if_unmodified_since of this CopyObjectRequest.
495
+ r"""Sets the x_obs_copy_source_if_unmodified_since of this CopyObjectRequest.
496
496
 
497
497
  Copies the source object only if it has not been modified since the time specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. This header can be used with **x-obs-copy-source-if-match**, but cannot be used with other conditional copy headers. Type: HTTP time string complying with the format specified at **http://www.ietf.org/rfc/rfc2616.txt** Example: x-obs-copy-source-if-unmodified -since: time-sta
498
498
 
@@ -503,7 +503,7 @@ class CopyObjectRequest:
503
503
 
504
504
  @property
505
505
  def x_obs_copy_source_if_modified_since(self):
506
- """Gets the x_obs_copy_source_if_modified_since of this CopyObjectRequest.
506
+ r"""Gets the x_obs_copy_source_if_modified_since of this CopyObjectRequest.
507
507
 
508
508
  Copies the source object only if it has been modified since the time specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. This header can be used with **x-obs-copy-source-if-none-match**, but cannot be used with other conditional copy headers. Type: HTTP time string complying with the format specified at **http://www.ietf.org/rfc/rfc2616.txt** Example: x-obs-copy-source-if-modified-since: time-sta
509
509
 
@@ -514,7 +514,7 @@ class CopyObjectRequest:
514
514
 
515
515
  @x_obs_copy_source_if_modified_since.setter
516
516
  def x_obs_copy_source_if_modified_since(self, x_obs_copy_source_if_modified_since):
517
- """Sets the x_obs_copy_source_if_modified_since of this CopyObjectRequest.
517
+ r"""Sets the x_obs_copy_source_if_modified_since of this CopyObjectRequest.
518
518
 
519
519
  Copies the source object only if it has been modified since the time specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. This header can be used with **x-obs-copy-source-if-none-match**, but cannot be used with other conditional copy headers. Type: HTTP time string complying with the format specified at **http://www.ietf.org/rfc/rfc2616.txt** Example: x-obs-copy-source-if-modified-since: time-sta
520
520
 
@@ -525,7 +525,7 @@ class CopyObjectRequest:
525
525
 
526
526
  @property
527
527
  def x_obs_storage_class(self):
528
- """Gets the x_obs_storage_class of this CopyObjectRequest.
528
+ r"""Gets the x_obs_storage_class of this CopyObjectRequest.
529
529
 
530
530
  When copying an object, you can use this header to specify a storage class for the target object. If you do not have this header configured, the target object inherits the default storage class of the bucket. Type: string Note: There are three storage classes: Standard (STANDARD), Infrequent Access (WARM), and Archive (COLD), so the value can be **STANDARD**, **WARM**, or **COLD**. The value is case sensitive. Example: x-obs-storage-class: STANDARD
531
531
 
@@ -536,7 +536,7 @@ class CopyObjectRequest:
536
536
 
537
537
  @x_obs_storage_class.setter
538
538
  def x_obs_storage_class(self, x_obs_storage_class):
539
- """Sets the x_obs_storage_class of this CopyObjectRequest.
539
+ r"""Sets the x_obs_storage_class of this CopyObjectRequest.
540
540
 
541
541
  When copying an object, you can use this header to specify a storage class for the target object. If you do not have this header configured, the target object inherits the default storage class of the bucket. Type: string Note: There are three storage classes: Standard (STANDARD), Infrequent Access (WARM), and Archive (COLD), so the value can be **STANDARD**, **WARM**, or **COLD**. The value is case sensitive. Example: x-obs-storage-class: STANDARD
542
542
 
@@ -547,7 +547,7 @@ class CopyObjectRequest:
547
547
 
548
548
  @property
549
549
  def x_obs_persistent_headers(self):
550
- """Gets the x_obs_persistent_headers of this CopyObjectRequest.
550
+ r"""Gets the x_obs_persistent_headers of this CopyObjectRequest.
551
551
 
552
552
  When copying an object, you can add the **x-obs-persistent-headers** header in an HTTP request to customize one or more response headers. When you retrieve the target object or query the object metadata, the custom headers will be returned in the response message. Type: string Format: **x-obs-persistent-headers: ****key1:base64_encode(***value1***),****key2:base64_encode(***value2***)...** Note: Items, such as **key1** and **key2**, are user-defined headers. If they contain non-ASCII or unrecognizable characters, they can be encoded using URL or Base64. The server processes these headers as strings, but does not decode them. Items, such as *value1* and *value2* are the values of the corresponding headers. **base64_encode** indicates that the value is encoded using Base64. A user-defined header and its Base64-encoded value are connected using a colon (:) to form a key-value pair. All key-value pairs are separated with a comma (,) and are placed in the **x-obs-persistent-headers** header. The server then decodes the uploaded value. Example: x-obs-persistent-headers: key1:dmFsdWUx,key2:dmFsdWUy When you download the target object or obtain the object metadata, headers **key1:***value1* and **key2:***value2* will be returned. Restrictions: + Response headers customized in this way cannot be prefixed with **x-obs-**. For example, you should use **key1**, instead of **x-obs-key1**. + Standard HTTP headers, such as **host**, **content-md5**, **origin**, **range**, and **Content-Disposition**, cannot be specified as custom headers. + The total length of this header and the custom metadata cannot exceed 8 KB. + If the same keys are transferred, values are separated with commas (,) and then returned in one key. + If the source object already has custom response headers, such response headers will not be copied to the target object.
553
553
 
@@ -558,7 +558,7 @@ class CopyObjectRequest:
558
558
 
559
559
  @x_obs_persistent_headers.setter
560
560
  def x_obs_persistent_headers(self, x_obs_persistent_headers):
561
- """Sets the x_obs_persistent_headers of this CopyObjectRequest.
561
+ r"""Sets the x_obs_persistent_headers of this CopyObjectRequest.
562
562
 
563
563
  When copying an object, you can add the **x-obs-persistent-headers** header in an HTTP request to customize one or more response headers. When you retrieve the target object or query the object metadata, the custom headers will be returned in the response message. Type: string Format: **x-obs-persistent-headers: ****key1:base64_encode(***value1***),****key2:base64_encode(***value2***)...** Note: Items, such as **key1** and **key2**, are user-defined headers. If they contain non-ASCII or unrecognizable characters, they can be encoded using URL or Base64. The server processes these headers as strings, but does not decode them. Items, such as *value1* and *value2* are the values of the corresponding headers. **base64_encode** indicates that the value is encoded using Base64. A user-defined header and its Base64-encoded value are connected using a colon (:) to form a key-value pair. All key-value pairs are separated with a comma (,) and are placed in the **x-obs-persistent-headers** header. The server then decodes the uploaded value. Example: x-obs-persistent-headers: key1:dmFsdWUx,key2:dmFsdWUy When you download the target object or obtain the object metadata, headers **key1:***value1* and **key2:***value2* will be returned. Restrictions: + Response headers customized in this way cannot be prefixed with **x-obs-**. For example, you should use **key1**, instead of **x-obs-key1**. + Standard HTTP headers, such as **host**, **content-md5**, **origin**, **range**, and **Content-Disposition**, cannot be specified as custom headers. + The total length of this header and the custom metadata cannot exceed 8 KB. + If the same keys are transferred, values are separated with commas (,) and then returned in one key. + If the source object already has custom response headers, such response headers will not be copied to the target object.
564
564
 
@@ -569,7 +569,7 @@ class CopyObjectRequest:
569
569
 
570
570
  @property
571
571
  def x_obs_website_redirect_location(self):
572
- """Gets the x_obs_website_redirect_location of this CopyObjectRequest.
572
+ r"""Gets the x_obs_website_redirect_location of this CopyObjectRequest.
573
573
 
574
574
  If static website hosting has been configured for a bucket, you can configure this parameter to redirect requests for an object in this bucket to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata. Type: string Default value: none Restriction: The value must start with a slash (/), **http://**, or **https://**, with a length of no more than 2 KB.
575
575
 
@@ -580,7 +580,7 @@ class CopyObjectRequest:
580
580
 
581
581
  @x_obs_website_redirect_location.setter
582
582
  def x_obs_website_redirect_location(self, x_obs_website_redirect_location):
583
- """Sets the x_obs_website_redirect_location of this CopyObjectRequest.
583
+ r"""Sets the x_obs_website_redirect_location of this CopyObjectRequest.
584
584
 
585
585
  If static website hosting has been configured for a bucket, you can configure this parameter to redirect requests for an object in this bucket to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata. Type: string Default value: none Restriction: The value must start with a slash (/), **http://**, or **https://**, with a length of no more than 2 KB.
586
586
 
@@ -591,7 +591,7 @@ class CopyObjectRequest:
591
591
 
592
592
  @property
593
593
  def x_obs_server_side_encryption(self):
594
- """Gets the x_obs_server_side_encryption of this CopyObjectRequest.
594
+ r"""Gets the x_obs_server_side_encryption of this CopyObjectRequest.
595
595
 
596
596
  Indicates that SSE-KMS is used. The target object is encrypted using SSE-KMS. Type: string Example: x-obs-server-side-encryption: kms This header is required when SSE-KMS is used.
597
597
 
@@ -602,7 +602,7 @@ class CopyObjectRequest:
602
602
 
603
603
  @x_obs_server_side_encryption.setter
604
604
  def x_obs_server_side_encryption(self, x_obs_server_side_encryption):
605
- """Sets the x_obs_server_side_encryption of this CopyObjectRequest.
605
+ r"""Sets the x_obs_server_side_encryption of this CopyObjectRequest.
606
606
 
607
607
  Indicates that SSE-KMS is used. The target object is encrypted using SSE-KMS. Type: string Example: x-obs-server-side-encryption: kms This header is required when SSE-KMS is used.
608
608
 
@@ -613,7 +613,7 @@ class CopyObjectRequest:
613
613
 
614
614
  @property
615
615
  def x_obs_server_side_encryption_kms_key_id(self):
616
- """Gets the x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
616
+ r"""Gets the x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
617
617
 
618
618
  The master key ID used to encrypt the target object when SSE-KMS is used. If the customer does not provide this ID, the default master key ID will be used. Type: string Supported formats: + *regionID***:***domainID***:key/***key_id* + *key_id*. *regionID* is the ID of the region to which the key belongs. *domainID* is the account ID of the tenant to which the key belongs. *key_id* is the key ID created on DEW. Examples: + x-obs-server-side-encryption-kms-key-id:cn-north-4:domainiddomainiddomainiddoma0001:key/4f1cd4de-ab64-4807-920a-47fc42e7f0d0 + x-obs-server-side-encryption-kms-key-id:4f1cd4de-ab64-4807-920a-47fc42e7f0d0
619
619
 
@@ -624,7 +624,7 @@ class CopyObjectRequest:
624
624
 
625
625
  @x_obs_server_side_encryption_kms_key_id.setter
626
626
  def x_obs_server_side_encryption_kms_key_id(self, x_obs_server_side_encryption_kms_key_id):
627
- """Sets the x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
627
+ r"""Sets the x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
628
628
 
629
629
  The master key ID used to encrypt the target object when SSE-KMS is used. If the customer does not provide this ID, the default master key ID will be used. Type: string Supported formats: + *regionID***:***domainID***:key/***key_id* + *key_id*. *regionID* is the ID of the region to which the key belongs. *domainID* is the account ID of the tenant to which the key belongs. *key_id* is the key ID created on DEW. Examples: + x-obs-server-side-encryption-kms-key-id:cn-north-4:domainiddomainiddomainiddoma0001:key/4f1cd4de-ab64-4807-920a-47fc42e7f0d0 + x-obs-server-side-encryption-kms-key-id:4f1cd4de-ab64-4807-920a-47fc42e7f0d0
630
630
 
@@ -635,7 +635,7 @@ class CopyObjectRequest:
635
635
 
636
636
  @property
637
637
  def x_obs_server_side_encryption_customer_algorithm(self):
638
- """Gets the x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
638
+ r"""Gets the x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
639
639
 
640
640
  The algorithm used to encrypt a target object when SSE-C is used. Type: string Example: x-obs-server-side-encryption-customer-algorithm: AES256 Restriction: This header must be used together with **x-obs-server-side-encryption-customer-key** and **x-obs-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used.
641
641
 
@@ -646,7 +646,7 @@ class CopyObjectRequest:
646
646
 
647
647
  @x_obs_server_side_encryption_customer_algorithm.setter
648
648
  def x_obs_server_side_encryption_customer_algorithm(self, x_obs_server_side_encryption_customer_algorithm):
649
- """Sets the x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
649
+ r"""Sets the x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
650
650
 
651
651
  The algorithm used to encrypt a target object when SSE-C is used. Type: string Example: x-obs-server-side-encryption-customer-algorithm: AES256 Restriction: This header must be used together with **x-obs-server-side-encryption-customer-key** and **x-obs-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used.
652
652
 
@@ -657,7 +657,7 @@ class CopyObjectRequest:
657
657
 
658
658
  @property
659
659
  def x_obs_server_side_encryption_customer_key(self):
660
- """Gets the x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
660
+ r"""Gets the x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
661
661
 
662
662
  The key used to encrypt a target object when SSE-C is used. Type: string Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= Restriction: This header is a Base64-encoded 256-bit key and must be used together with **x-obs-server-side-encryption-customer-algorithm** and **x-obs-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used.
663
663
 
@@ -668,7 +668,7 @@ class CopyObjectRequest:
668
668
 
669
669
  @x_obs_server_side_encryption_customer_key.setter
670
670
  def x_obs_server_side_encryption_customer_key(self, x_obs_server_side_encryption_customer_key):
671
- """Sets the x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
671
+ r"""Sets the x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
672
672
 
673
673
  The key used to encrypt a target object when SSE-C is used. Type: string Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= Restriction: This header is a Base64-encoded 256-bit key and must be used together with **x-obs-server-side-encryption-customer-algorithm** and **x-obs-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used.
674
674
 
@@ -679,7 +679,7 @@ class CopyObjectRequest:
679
679
 
680
680
  @property
681
681
  def x_obs_server_side_encryption_customer_key_md5(self):
682
- """Gets the x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
682
+ r"""Gets the x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
683
683
 
684
684
  The MD5 value of a key used to encrypt a target object when SSE-C is used. An MD5 value is used to ensure that there is no error during the key transmission. Type: string Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== Restriction: This header is a Base64-encoded 128-bit MD5 value and must be used together with **x-obs-server-side-encryption-customer-algorithm** and **x-obs-server-side-encryption-customer-key**. This header is required when SSE-C is used.
685
685
 
@@ -690,7 +690,7 @@ class CopyObjectRequest:
690
690
 
691
691
  @x_obs_server_side_encryption_customer_key_md5.setter
692
692
  def x_obs_server_side_encryption_customer_key_md5(self, x_obs_server_side_encryption_customer_key_md5):
693
- """Sets the x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
693
+ r"""Sets the x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
694
694
 
695
695
  The MD5 value of a key used to encrypt a target object when SSE-C is used. An MD5 value is used to ensure that there is no error during the key transmission. Type: string Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== Restriction: This header is a Base64-encoded 128-bit MD5 value and must be used together with **x-obs-server-side-encryption-customer-algorithm** and **x-obs-server-side-encryption-customer-key**. This header is required when SSE-C is used.
696
696
 
@@ -701,7 +701,7 @@ class CopyObjectRequest:
701
701
 
702
702
  @property
703
703
  def x_obs_copy_source_server_side_encryption_customer_algorithm(self):
704
- """Gets the x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
704
+ r"""Gets the x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
705
705
 
706
706
  The algorithm used to decrypt the source object when SSE-C is used. Type: string Example: x-obs-copy-source-server-side-encryption-customer-algorithm: AES256 Restriction: This header must be used together with **x-obs-copy-source-server-side-encryption-customer-key** and **x-obs-copy-source-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used during the copy of the source object.
707
707
 
@@ -712,7 +712,7 @@ class CopyObjectRequest:
712
712
 
713
713
  @x_obs_copy_source_server_side_encryption_customer_algorithm.setter
714
714
  def x_obs_copy_source_server_side_encryption_customer_algorithm(self, x_obs_copy_source_server_side_encryption_customer_algorithm):
715
- """Sets the x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
715
+ r"""Sets the x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
716
716
 
717
717
  The algorithm used to decrypt the source object when SSE-C is used. Type: string Example: x-obs-copy-source-server-side-encryption-customer-algorithm: AES256 Restriction: This header must be used together with **x-obs-copy-source-server-side-encryption-customer-key** and **x-obs-copy-source-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used during the copy of the source object.
718
718
 
@@ -723,7 +723,7 @@ class CopyObjectRequest:
723
723
 
724
724
  @property
725
725
  def x_obs_copy_source_server_side_encryption_customer_key(self):
726
- """Gets the x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
726
+ r"""Gets the x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
727
727
 
728
728
  The key used to decrypt the source object when SSE-C is used. This header decrypts the source object. Type: string Example: x-obs-copy-source-server-side-encryption-customer-key: K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= Restriction: This header is a Base64-encoded 256-bit key and must be used together with **x-obs-copy-source-server-side-encryption-customer-algorithm** and **x-obs-copy-source-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used during the copy of the source object.
729
729
 
@@ -734,7 +734,7 @@ class CopyObjectRequest:
734
734
 
735
735
  @x_obs_copy_source_server_side_encryption_customer_key.setter
736
736
  def x_obs_copy_source_server_side_encryption_customer_key(self, x_obs_copy_source_server_side_encryption_customer_key):
737
- """Sets the x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
737
+ r"""Sets the x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
738
738
 
739
739
  The key used to decrypt the source object when SSE-C is used. This header decrypts the source object. Type: string Example: x-obs-copy-source-server-side-encryption-customer-key: K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= Restriction: This header is a Base64-encoded 256-bit key and must be used together with **x-obs-copy-source-server-side-encryption-customer-algorithm** and **x-obs-copy-source-server-side-encryption-customer-key-MD5**. This header is required when SSE-C is used during the copy of the source object.
740
740
 
@@ -745,7 +745,7 @@ class CopyObjectRequest:
745
745
 
746
746
  @property
747
747
  def x_obs_copy_source_server_side_encryption_customer_key_md5(self):
748
- """Gets the x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
748
+ r"""Gets the x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
749
749
 
750
750
  The MD5 value of the key used to decrypt the source object when SSE-C is used. An MD5 value is used to ensure that there is no error during the key transmission. Type: string Example: x-obs-copy-source-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== Restriction: This header is a Base64-encoded 128-bit MD5 value and must be used together with **x-obs-copy-source-server-side-encryption-customer-algorithm** and **x-obs-copy-source-server-side-encryption-customer-key**. This header is required when SSE-C is used during the copy of the source object.
751
751
 
@@ -756,7 +756,7 @@ class CopyObjectRequest:
756
756
 
757
757
  @x_obs_copy_source_server_side_encryption_customer_key_md5.setter
758
758
  def x_obs_copy_source_server_side_encryption_customer_key_md5(self, x_obs_copy_source_server_side_encryption_customer_key_md5):
759
- """Sets the x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
759
+ r"""Sets the x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
760
760
 
761
761
  The MD5 value of the key used to decrypt the source object when SSE-C is used. An MD5 value is used to ensure that there is no error during the key transmission. Type: string Example: x-obs-copy-source-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== Restriction: This header is a Base64-encoded 128-bit MD5 value and must be used together with **x-obs-copy-source-server-side-encryption-customer-algorithm** and **x-obs-copy-source-server-side-encryption-customer-key**. This header is required when SSE-C is used during the copy of the source object.
762
762
 
@@ -767,7 +767,7 @@ class CopyObjectRequest:
767
767
 
768
768
  @property
769
769
  def success_action_redirect(self):
770
- """Gets the success_action_redirect of this CopyObjectRequest.
770
+ r"""Gets the success_action_redirect of this CopyObjectRequest.
771
771
 
772
772
  The address (a URL) which a successfully responded request is redirected to. If this parameter value is valid and the request succeeds, OBS returns status code 303. The **Location** header consists of **success_action_redirect** as well as the bucket name, object name, and object ETag. If this parameter is invalid, OBS ignores this parameter and returns status code 204. In such case, the **Location** header is the object address. Type: string
773
773
 
@@ -778,7 +778,7 @@ class CopyObjectRequest:
778
778
 
779
779
  @success_action_redirect.setter
780
780
  def success_action_redirect(self, success_action_redirect):
781
- """Sets the success_action_redirect of this CopyObjectRequest.
781
+ r"""Sets the success_action_redirect of this CopyObjectRequest.
782
782
 
783
783
  The address (a URL) which a successfully responded request is redirected to. If this parameter value is valid and the request succeeds, OBS returns status code 303. The **Location** header consists of **success_action_redirect** as well as the bucket name, object name, and object ETag. If this parameter is invalid, OBS ignores this parameter and returns status code 204. In such case, the **Location** header is the object address. Type: string
784
784