huaweicloudsdkobs 3.1.76__py2.py3-none-any.whl → 3.1.78__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- huaweicloudsdkobs/v1/__init__.py +0 -1
- huaweicloudsdkobs/v1/model/__init__.py +0 -1
- huaweicloudsdkobs/v1/model/bucket.py +15 -15
- huaweicloudsdkobs/v1/model/contents.py +18 -18
- huaweicloudsdkobs/v1/model/copy_object_request.py +78 -78
- huaweicloudsdkobs/v1/model/copy_object_response.py +3 -3
- huaweicloudsdkobs/v1/model/create_bucket_request.py +51 -51
- huaweicloudsdkobs/v1/model/create_bucket_request_body.py +3 -3
- huaweicloudsdkobs/v1/model/delete_bucket_customdomain_request.py +9 -9
- huaweicloudsdkobs/v1/model/delete_bucket_request.py +6 -6
- huaweicloudsdkobs/v1/model/delete_object.py +6 -6
- huaweicloudsdkobs/v1/model/delete_object_request.py +12 -12
- huaweicloudsdkobs/v1/model/delete_objects_request.py +12 -12
- huaweicloudsdkobs/v1/model/delete_objects_request_body.py +6 -6
- huaweicloudsdkobs/v1/model/delete_objects_response.py +3 -3
- huaweicloudsdkobs/v1/model/delete_result_deleted.py +12 -12
- huaweicloudsdkobs/v1/model/delete_result_error.py +9 -9
- huaweicloudsdkobs/v1/model/domains.py +9 -9
- huaweicloudsdkobs/v1/model/filter_rule.py +6 -6
- huaweicloudsdkobs/v1/model/function_stage_configuration.py +12 -12
- huaweicloudsdkobs/v1/model/get_bucket_acl_request.py +9 -9
- huaweicloudsdkobs/v1/model/get_bucket_customdomain_request.py +9 -9
- huaweicloudsdkobs/v1/model/get_bucket_customdomain_response.py +5 -9
- huaweicloudsdkobs/v1/model/get_bucket_metadata_request.py +12 -12
- huaweicloudsdkobs/v1/model/get_bucket_notification_request.py +9 -9
- huaweicloudsdkobs/v1/model/get_object_metadata_request.py +33 -33
- huaweicloudsdkobs/v1/model/get_object_request.py +60 -60
- huaweicloudsdkobs/v1/model/grant.py +6 -6
- huaweicloudsdkobs/v1/model/grantee.py +6 -6
- huaweicloudsdkobs/v1/model/list_buckets_request.py +6 -6
- huaweicloudsdkobs/v1/model/list_buckets_response.py +4 -4
- huaweicloudsdkobs/v1/model/list_objects_request.py +27 -27
- huaweicloudsdkobs/v1/model/list_objects_response.py +27 -27
- huaweicloudsdkobs/v1/model/owner.py +3 -3
- huaweicloudsdkobs/v1/model/put_object_request.py +60 -60
- huaweicloudsdkobs/v1/model/set_bucket_acl_request.py +12 -12
- huaweicloudsdkobs/v1/model/set_bucket_custom_domain_body.py +15 -15
- huaweicloudsdkobs/v1/model/set_bucket_customedomain_request.py +9 -9
- huaweicloudsdkobs/v1/model/set_bucket_notification_request.py +9 -9
- huaweicloudsdkobs/v1/model/topic_configuration.py +9 -9
- huaweicloudsdkobs/v1/obs_async_client.py +543 -557
- huaweicloudsdkobs/v1/obs_client.py +543 -557
- huaweicloudsdkobs/v1/region/obs_region.py +4 -8
- {huaweicloudsdkobs-3.1.76.dist-info → huaweicloudsdkobs-3.1.78.dist-info}/METADATA +2 -2
- huaweicloudsdkobs-3.1.78.dist-info/RECORD +70 -0
- huaweicloudsdkobs/v1/model/buckets.py +0 -117
- huaweicloudsdkobs-3.1.76.dist-info/RECORD +0 -71
- {huaweicloudsdkobs-3.1.76.dist-info → huaweicloudsdkobs-3.1.78.dist-info}/LICENSE +0 -0
- {huaweicloudsdkobs-3.1.76.dist-info → huaweicloudsdkobs-3.1.78.dist-info}/WHEEL +0 -0
- {huaweicloudsdkobs-3.1.76.dist-info → huaweicloudsdkobs-3.1.78.dist-info}/top_level.txt +0 -0
|
@@ -81,57 +81,57 @@ class CopyObjectRequest:
|
|
|
81
81
|
|
|
82
82
|
The model defined in huaweicloud sdk
|
|
83
83
|
|
|
84
|
-
:param date:
|
|
84
|
+
:param date: 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.
|
|
85
85
|
:type date: str
|
|
86
|
-
:param bucket_name:
|
|
86
|
+
:param bucket_name: Name of the requested bucket
|
|
87
87
|
:type bucket_name: str
|
|
88
|
-
:param object_key:
|
|
88
|
+
:param object_key: Name of the object copy.
|
|
89
89
|
:type object_key: str
|
|
90
|
-
:param x_obs_acl:
|
|
90
|
+
:param x_obs_acl: 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
|
|
91
91
|
:type x_obs_acl: str
|
|
92
|
-
:param x_obs_grant_read:
|
|
92
|
+
:param x_obs_grant_read: 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.
|
|
93
93
|
:type x_obs_grant_read: str
|
|
94
|
-
:param x_obs_grant_read_acp:
|
|
94
|
+
:param x_obs_grant_read_acp: When creating an object, you can use this header to grant all users in a domain the permissions to obtain the object ACL.
|
|
95
95
|
:type x_obs_grant_read_acp: str
|
|
96
|
-
:param x_obs_grant_write_acp:
|
|
96
|
+
:param x_obs_grant_write_acp: When creating an object, you can use this header to grant all users in a domain the permissions to write the object ACL.
|
|
97
97
|
:type x_obs_grant_write_acp: str
|
|
98
|
-
:param x_obs_grant_full_control:
|
|
98
|
+
:param x_obs_grant_full_control: 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.
|
|
99
99
|
:type x_obs_grant_full_control: str
|
|
100
|
-
:param x_obs_copy_source:
|
|
100
|
+
:param x_obs_copy_source: 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
|
|
101
101
|
:type x_obs_copy_source: str
|
|
102
|
-
:param x_obs_metadata_directive:
|
|
102
|
+
:param x_obs_metadata_directive: 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.
|
|
103
103
|
:type x_obs_metadata_directive: str
|
|
104
|
-
:param x_obs_copy_source_if_match:
|
|
104
|
+
:param x_obs_copy_source_if_match: 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.
|
|
105
105
|
:type x_obs_copy_source_if_match: str
|
|
106
|
-
:param x_obs_copy_source_if_none_match:
|
|
106
|
+
:param x_obs_copy_source_if_none_match: 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.
|
|
107
107
|
:type x_obs_copy_source_if_none_match: str
|
|
108
|
-
:param x_obs_copy_source_if_unmodified_since:
|
|
108
|
+
:param x_obs_copy_source_if_unmodified_since: 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
|
|
109
109
|
:type x_obs_copy_source_if_unmodified_since: str
|
|
110
|
-
:param x_obs_copy_source_if_modified_since:
|
|
110
|
+
:param x_obs_copy_source_if_modified_since: 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
|
|
111
111
|
:type x_obs_copy_source_if_modified_since: str
|
|
112
|
-
:param x_obs_storage_class:
|
|
112
|
+
:param x_obs_storage_class: 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
|
|
113
113
|
:type x_obs_storage_class: str
|
|
114
|
-
:param x_obs_persistent_headers:
|
|
114
|
+
:param x_obs_persistent_headers: 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.
|
|
115
115
|
:type x_obs_persistent_headers: str
|
|
116
|
-
:param x_obs_website_redirect_location:
|
|
116
|
+
:param x_obs_website_redirect_location: 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.
|
|
117
117
|
:type x_obs_website_redirect_location: str
|
|
118
|
-
:param x_obs_server_side_encryption:
|
|
118
|
+
:param x_obs_server_side_encryption: 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.
|
|
119
119
|
:type x_obs_server_side_encryption: str
|
|
120
|
-
:param x_obs_server_side_encryption_kms_key_id: SSE-KMS
|
|
120
|
+
:param x_obs_server_side_encryption_kms_key_id: 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
|
|
121
121
|
:type x_obs_server_side_encryption_kms_key_id: str
|
|
122
|
-
:param x_obs_server_side_encryption_customer_algorithm: SSE-C
|
|
122
|
+
:param x_obs_server_side_encryption_customer_algorithm: 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.
|
|
123
123
|
:type x_obs_server_side_encryption_customer_algorithm: str
|
|
124
|
-
:param x_obs_server_side_encryption_customer_key: SSE-C
|
|
124
|
+
:param x_obs_server_side_encryption_customer_key: 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.
|
|
125
125
|
:type x_obs_server_side_encryption_customer_key: str
|
|
126
|
-
:param x_obs_server_side_encryption_customer_key_md5: SSE-C
|
|
126
|
+
:param x_obs_server_side_encryption_customer_key_md5: 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.
|
|
127
127
|
:type x_obs_server_side_encryption_customer_key_md5: str
|
|
128
|
-
:param x_obs_copy_source_server_side_encryption_customer_algorithm: SSE-C
|
|
128
|
+
:param x_obs_copy_source_server_side_encryption_customer_algorithm: 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.
|
|
129
129
|
:type x_obs_copy_source_server_side_encryption_customer_algorithm: str
|
|
130
|
-
:param x_obs_copy_source_server_side_encryption_customer_key: SSE-C
|
|
130
|
+
:param x_obs_copy_source_server_side_encryption_customer_key: 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.
|
|
131
131
|
:type x_obs_copy_source_server_side_encryption_customer_key: str
|
|
132
|
-
:param x_obs_copy_source_server_side_encryption_customer_key_md5: SSE-C
|
|
132
|
+
:param x_obs_copy_source_server_side_encryption_customer_key_md5: 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.
|
|
133
133
|
:type x_obs_copy_source_server_side_encryption_customer_key_md5: str
|
|
134
|
-
:param success_action_redirect:
|
|
134
|
+
:param success_action_redirect: 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
|
|
135
135
|
:type success_action_redirect: str
|
|
136
136
|
"""
|
|
137
137
|
|
|
@@ -219,7 +219,7 @@ class CopyObjectRequest:
|
|
|
219
219
|
def date(self):
|
|
220
220
|
"""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
|
|
|
224
224
|
:return: The date of this CopyObjectRequest.
|
|
225
225
|
:rtype: str
|
|
@@ -230,7 +230,7 @@ class CopyObjectRequest:
|
|
|
230
230
|
def date(self, date):
|
|
231
231
|
"""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
|
|
|
235
235
|
:param date: The date of this CopyObjectRequest.
|
|
236
236
|
:type date: str
|
|
@@ -241,7 +241,7 @@ class CopyObjectRequest:
|
|
|
241
241
|
def bucket_name(self):
|
|
242
242
|
"""Gets the bucket_name of this CopyObjectRequest.
|
|
243
243
|
|
|
244
|
-
|
|
244
|
+
Name of the requested bucket
|
|
245
245
|
|
|
246
246
|
:return: The bucket_name of this CopyObjectRequest.
|
|
247
247
|
:rtype: str
|
|
@@ -252,7 +252,7 @@ class CopyObjectRequest:
|
|
|
252
252
|
def bucket_name(self, bucket_name):
|
|
253
253
|
"""Sets the bucket_name of this CopyObjectRequest.
|
|
254
254
|
|
|
255
|
-
|
|
255
|
+
Name of the requested bucket
|
|
256
256
|
|
|
257
257
|
:param bucket_name: The bucket_name of this CopyObjectRequest.
|
|
258
258
|
:type bucket_name: str
|
|
@@ -263,7 +263,7 @@ class CopyObjectRequest:
|
|
|
263
263
|
def object_key(self):
|
|
264
264
|
"""Gets the object_key of this CopyObjectRequest.
|
|
265
265
|
|
|
266
|
-
|
|
266
|
+
Name of the object copy.
|
|
267
267
|
|
|
268
268
|
:return: The object_key of this CopyObjectRequest.
|
|
269
269
|
:rtype: str
|
|
@@ -274,7 +274,7 @@ class CopyObjectRequest:
|
|
|
274
274
|
def object_key(self, object_key):
|
|
275
275
|
"""Sets the object_key of this CopyObjectRequest.
|
|
276
276
|
|
|
277
|
-
|
|
277
|
+
Name of the object copy.
|
|
278
278
|
|
|
279
279
|
:param object_key: The object_key of this CopyObjectRequest.
|
|
280
280
|
:type object_key: str
|
|
@@ -285,7 +285,7 @@ class CopyObjectRequest:
|
|
|
285
285
|
def x_obs_acl(self):
|
|
286
286
|
"""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
|
|
|
290
290
|
:return: The x_obs_acl of this CopyObjectRequest.
|
|
291
291
|
:rtype: str
|
|
@@ -296,7 +296,7 @@ class CopyObjectRequest:
|
|
|
296
296
|
def x_obs_acl(self, x_obs_acl):
|
|
297
297
|
"""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
|
|
|
301
301
|
:param x_obs_acl: The x_obs_acl of this CopyObjectRequest.
|
|
302
302
|
:type x_obs_acl: str
|
|
@@ -307,7 +307,7 @@ class CopyObjectRequest:
|
|
|
307
307
|
def x_obs_grant_read(self):
|
|
308
308
|
"""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
|
|
|
312
312
|
:return: The x_obs_grant_read of this CopyObjectRequest.
|
|
313
313
|
:rtype: str
|
|
@@ -318,7 +318,7 @@ class CopyObjectRequest:
|
|
|
318
318
|
def x_obs_grant_read(self, x_obs_grant_read):
|
|
319
319
|
"""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
|
|
|
323
323
|
:param x_obs_grant_read: The x_obs_grant_read of this CopyObjectRequest.
|
|
324
324
|
:type x_obs_grant_read: str
|
|
@@ -329,7 +329,7 @@ class CopyObjectRequest:
|
|
|
329
329
|
def x_obs_grant_read_acp(self):
|
|
330
330
|
"""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
|
|
|
334
334
|
:return: The x_obs_grant_read_acp of this CopyObjectRequest.
|
|
335
335
|
:rtype: str
|
|
@@ -340,7 +340,7 @@ class CopyObjectRequest:
|
|
|
340
340
|
def x_obs_grant_read_acp(self, x_obs_grant_read_acp):
|
|
341
341
|
"""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
|
|
|
345
345
|
:param x_obs_grant_read_acp: The x_obs_grant_read_acp of this CopyObjectRequest.
|
|
346
346
|
:type x_obs_grant_read_acp: str
|
|
@@ -351,7 +351,7 @@ class CopyObjectRequest:
|
|
|
351
351
|
def x_obs_grant_write_acp(self):
|
|
352
352
|
"""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
|
|
|
356
356
|
:return: The x_obs_grant_write_acp of this CopyObjectRequest.
|
|
357
357
|
:rtype: str
|
|
@@ -362,7 +362,7 @@ class CopyObjectRequest:
|
|
|
362
362
|
def x_obs_grant_write_acp(self, x_obs_grant_write_acp):
|
|
363
363
|
"""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
|
|
|
367
367
|
:param x_obs_grant_write_acp: The x_obs_grant_write_acp of this CopyObjectRequest.
|
|
368
368
|
:type x_obs_grant_write_acp: str
|
|
@@ -373,7 +373,7 @@ class CopyObjectRequest:
|
|
|
373
373
|
def x_obs_grant_full_control(self):
|
|
374
374
|
"""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
|
|
|
378
378
|
:return: The x_obs_grant_full_control of this CopyObjectRequest.
|
|
379
379
|
:rtype: str
|
|
@@ -384,7 +384,7 @@ class CopyObjectRequest:
|
|
|
384
384
|
def x_obs_grant_full_control(self, x_obs_grant_full_control):
|
|
385
385
|
"""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
|
|
|
389
389
|
:param x_obs_grant_full_control: The x_obs_grant_full_control of this CopyObjectRequest.
|
|
390
390
|
:type x_obs_grant_full_control: str
|
|
@@ -395,7 +395,7 @@ class CopyObjectRequest:
|
|
|
395
395
|
def x_obs_copy_source(self):
|
|
396
396
|
"""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
|
|
|
400
400
|
:return: The x_obs_copy_source of this CopyObjectRequest.
|
|
401
401
|
:rtype: str
|
|
@@ -406,7 +406,7 @@ class CopyObjectRequest:
|
|
|
406
406
|
def x_obs_copy_source(self, x_obs_copy_source):
|
|
407
407
|
"""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
|
|
|
411
411
|
:param x_obs_copy_source: The x_obs_copy_source of this CopyObjectRequest.
|
|
412
412
|
:type x_obs_copy_source: str
|
|
@@ -417,7 +417,7 @@ class CopyObjectRequest:
|
|
|
417
417
|
def x_obs_metadata_directive(self):
|
|
418
418
|
"""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
|
|
|
422
422
|
:return: The x_obs_metadata_directive of this CopyObjectRequest.
|
|
423
423
|
:rtype: str
|
|
@@ -428,7 +428,7 @@ class CopyObjectRequest:
|
|
|
428
428
|
def x_obs_metadata_directive(self, x_obs_metadata_directive):
|
|
429
429
|
"""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
|
|
|
433
433
|
:param x_obs_metadata_directive: The x_obs_metadata_directive of this CopyObjectRequest.
|
|
434
434
|
:type x_obs_metadata_directive: str
|
|
@@ -439,7 +439,7 @@ class CopyObjectRequest:
|
|
|
439
439
|
def x_obs_copy_source_if_match(self):
|
|
440
440
|
"""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
|
|
|
444
444
|
:return: The x_obs_copy_source_if_match of this CopyObjectRequest.
|
|
445
445
|
:rtype: str
|
|
@@ -450,7 +450,7 @@ class CopyObjectRequest:
|
|
|
450
450
|
def x_obs_copy_source_if_match(self, x_obs_copy_source_if_match):
|
|
451
451
|
"""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
|
|
|
455
455
|
:param x_obs_copy_source_if_match: The x_obs_copy_source_if_match of this CopyObjectRequest.
|
|
456
456
|
:type x_obs_copy_source_if_match: str
|
|
@@ -461,7 +461,7 @@ class CopyObjectRequest:
|
|
|
461
461
|
def x_obs_copy_source_if_none_match(self):
|
|
462
462
|
"""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
|
|
|
466
466
|
:return: The x_obs_copy_source_if_none_match of this CopyObjectRequest.
|
|
467
467
|
:rtype: str
|
|
@@ -472,7 +472,7 @@ class CopyObjectRequest:
|
|
|
472
472
|
def x_obs_copy_source_if_none_match(self, x_obs_copy_source_if_none_match):
|
|
473
473
|
"""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
|
|
|
477
477
|
:param x_obs_copy_source_if_none_match: The x_obs_copy_source_if_none_match of this CopyObjectRequest.
|
|
478
478
|
:type x_obs_copy_source_if_none_match: str
|
|
@@ -483,7 +483,7 @@ class CopyObjectRequest:
|
|
|
483
483
|
def x_obs_copy_source_if_unmodified_since(self):
|
|
484
484
|
"""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
|
|
|
488
488
|
:return: The x_obs_copy_source_if_unmodified_since of this CopyObjectRequest.
|
|
489
489
|
:rtype: str
|
|
@@ -494,7 +494,7 @@ class CopyObjectRequest:
|
|
|
494
494
|
def x_obs_copy_source_if_unmodified_since(self, x_obs_copy_source_if_unmodified_since):
|
|
495
495
|
"""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
|
|
|
499
499
|
:param x_obs_copy_source_if_unmodified_since: The x_obs_copy_source_if_unmodified_since of this CopyObjectRequest.
|
|
500
500
|
:type x_obs_copy_source_if_unmodified_since: str
|
|
@@ -505,7 +505,7 @@ class CopyObjectRequest:
|
|
|
505
505
|
def x_obs_copy_source_if_modified_since(self):
|
|
506
506
|
"""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
|
|
|
510
510
|
:return: The x_obs_copy_source_if_modified_since of this CopyObjectRequest.
|
|
511
511
|
:rtype: str
|
|
@@ -516,7 +516,7 @@ class CopyObjectRequest:
|
|
|
516
516
|
def x_obs_copy_source_if_modified_since(self, x_obs_copy_source_if_modified_since):
|
|
517
517
|
"""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
|
|
|
521
521
|
:param x_obs_copy_source_if_modified_since: The x_obs_copy_source_if_modified_since of this CopyObjectRequest.
|
|
522
522
|
:type x_obs_copy_source_if_modified_since: str
|
|
@@ -527,7 +527,7 @@ class CopyObjectRequest:
|
|
|
527
527
|
def x_obs_storage_class(self):
|
|
528
528
|
"""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
|
|
|
532
532
|
:return: The x_obs_storage_class of this CopyObjectRequest.
|
|
533
533
|
:rtype: str
|
|
@@ -538,7 +538,7 @@ class CopyObjectRequest:
|
|
|
538
538
|
def x_obs_storage_class(self, x_obs_storage_class):
|
|
539
539
|
"""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
|
|
|
543
543
|
:param x_obs_storage_class: The x_obs_storage_class of this CopyObjectRequest.
|
|
544
544
|
:type x_obs_storage_class: str
|
|
@@ -549,7 +549,7 @@ class CopyObjectRequest:
|
|
|
549
549
|
def x_obs_persistent_headers(self):
|
|
550
550
|
"""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
|
|
|
554
554
|
:return: The x_obs_persistent_headers of this CopyObjectRequest.
|
|
555
555
|
:rtype: str
|
|
@@ -560,7 +560,7 @@ class CopyObjectRequest:
|
|
|
560
560
|
def x_obs_persistent_headers(self, x_obs_persistent_headers):
|
|
561
561
|
"""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
|
|
|
565
565
|
:param x_obs_persistent_headers: The x_obs_persistent_headers of this CopyObjectRequest.
|
|
566
566
|
:type x_obs_persistent_headers: str
|
|
@@ -571,7 +571,7 @@ class CopyObjectRequest:
|
|
|
571
571
|
def x_obs_website_redirect_location(self):
|
|
572
572
|
"""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
|
|
|
576
576
|
:return: The x_obs_website_redirect_location of this CopyObjectRequest.
|
|
577
577
|
:rtype: str
|
|
@@ -582,7 +582,7 @@ class CopyObjectRequest:
|
|
|
582
582
|
def x_obs_website_redirect_location(self, x_obs_website_redirect_location):
|
|
583
583
|
"""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
|
|
|
587
587
|
:param x_obs_website_redirect_location: The x_obs_website_redirect_location of this CopyObjectRequest.
|
|
588
588
|
:type x_obs_website_redirect_location: str
|
|
@@ -593,7 +593,7 @@ class CopyObjectRequest:
|
|
|
593
593
|
def x_obs_server_side_encryption(self):
|
|
594
594
|
"""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
|
|
|
598
598
|
:return: The x_obs_server_side_encryption of this CopyObjectRequest.
|
|
599
599
|
:rtype: str
|
|
@@ -604,7 +604,7 @@ class CopyObjectRequest:
|
|
|
604
604
|
def x_obs_server_side_encryption(self, x_obs_server_side_encryption):
|
|
605
605
|
"""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
|
|
|
609
609
|
:param x_obs_server_side_encryption: The x_obs_server_side_encryption of this CopyObjectRequest.
|
|
610
610
|
:type x_obs_server_side_encryption: str
|
|
@@ -615,7 +615,7 @@ class CopyObjectRequest:
|
|
|
615
615
|
def x_obs_server_side_encryption_kms_key_id(self):
|
|
616
616
|
"""Gets the x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
|
|
617
617
|
|
|
618
|
-
SSE-KMS
|
|
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
|
|
|
620
620
|
:return: The x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
|
|
621
621
|
:rtype: str
|
|
@@ -626,7 +626,7 @@ class CopyObjectRequest:
|
|
|
626
626
|
def x_obs_server_side_encryption_kms_key_id(self, x_obs_server_side_encryption_kms_key_id):
|
|
627
627
|
"""Sets the x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
|
|
628
628
|
|
|
629
|
-
SSE-KMS
|
|
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
|
|
|
631
631
|
:param x_obs_server_side_encryption_kms_key_id: The x_obs_server_side_encryption_kms_key_id of this CopyObjectRequest.
|
|
632
632
|
:type x_obs_server_side_encryption_kms_key_id: str
|
|
@@ -637,7 +637,7 @@ class CopyObjectRequest:
|
|
|
637
637
|
def x_obs_server_side_encryption_customer_algorithm(self):
|
|
638
638
|
"""Gets the x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
639
639
|
|
|
640
|
-
SSE-C
|
|
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
|
|
|
642
642
|
:return: The x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
643
643
|
:rtype: str
|
|
@@ -648,7 +648,7 @@ class CopyObjectRequest:
|
|
|
648
648
|
def x_obs_server_side_encryption_customer_algorithm(self, x_obs_server_side_encryption_customer_algorithm):
|
|
649
649
|
"""Sets the x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
650
650
|
|
|
651
|
-
SSE-C
|
|
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
|
|
|
653
653
|
:param x_obs_server_side_encryption_customer_algorithm: The x_obs_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
654
654
|
:type x_obs_server_side_encryption_customer_algorithm: str
|
|
@@ -659,7 +659,7 @@ class CopyObjectRequest:
|
|
|
659
659
|
def x_obs_server_side_encryption_customer_key(self):
|
|
660
660
|
"""Gets the x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
661
661
|
|
|
662
|
-
SSE-C
|
|
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
|
|
|
664
664
|
:return: The x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
665
665
|
:rtype: str
|
|
@@ -670,7 +670,7 @@ class CopyObjectRequest:
|
|
|
670
670
|
def x_obs_server_side_encryption_customer_key(self, x_obs_server_side_encryption_customer_key):
|
|
671
671
|
"""Sets the x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
672
672
|
|
|
673
|
-
SSE-C
|
|
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
|
|
|
675
675
|
:param x_obs_server_side_encryption_customer_key: The x_obs_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
676
676
|
:type x_obs_server_side_encryption_customer_key: str
|
|
@@ -681,7 +681,7 @@ class CopyObjectRequest:
|
|
|
681
681
|
def x_obs_server_side_encryption_customer_key_md5(self):
|
|
682
682
|
"""Gets the x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
683
683
|
|
|
684
|
-
SSE-C
|
|
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
|
|
|
686
686
|
:return: The x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
687
687
|
:rtype: str
|
|
@@ -692,7 +692,7 @@ class CopyObjectRequest:
|
|
|
692
692
|
def x_obs_server_side_encryption_customer_key_md5(self, x_obs_server_side_encryption_customer_key_md5):
|
|
693
693
|
"""Sets the x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
694
694
|
|
|
695
|
-
SSE-C
|
|
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
|
|
|
697
697
|
:param x_obs_server_side_encryption_customer_key_md5: The x_obs_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
698
698
|
:type x_obs_server_side_encryption_customer_key_md5: str
|
|
@@ -703,7 +703,7 @@ class CopyObjectRequest:
|
|
|
703
703
|
def x_obs_copy_source_server_side_encryption_customer_algorithm(self):
|
|
704
704
|
"""Gets the x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
705
705
|
|
|
706
|
-
SSE-C
|
|
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
|
|
|
708
708
|
:return: The x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
709
709
|
:rtype: str
|
|
@@ -714,7 +714,7 @@ class CopyObjectRequest:
|
|
|
714
714
|
def x_obs_copy_source_server_side_encryption_customer_algorithm(self, x_obs_copy_source_server_side_encryption_customer_algorithm):
|
|
715
715
|
"""Sets the x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
716
716
|
|
|
717
|
-
SSE-C
|
|
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
|
|
|
719
719
|
:param x_obs_copy_source_server_side_encryption_customer_algorithm: The x_obs_copy_source_server_side_encryption_customer_algorithm of this CopyObjectRequest.
|
|
720
720
|
:type x_obs_copy_source_server_side_encryption_customer_algorithm: str
|
|
@@ -725,7 +725,7 @@ class CopyObjectRequest:
|
|
|
725
725
|
def x_obs_copy_source_server_side_encryption_customer_key(self):
|
|
726
726
|
"""Gets the x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
727
727
|
|
|
728
|
-
SSE-C
|
|
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
|
|
|
730
730
|
:return: The x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
731
731
|
:rtype: str
|
|
@@ -736,7 +736,7 @@ class CopyObjectRequest:
|
|
|
736
736
|
def x_obs_copy_source_server_side_encryption_customer_key(self, x_obs_copy_source_server_side_encryption_customer_key):
|
|
737
737
|
"""Sets the x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
738
738
|
|
|
739
|
-
SSE-C
|
|
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
|
|
|
741
741
|
:param x_obs_copy_source_server_side_encryption_customer_key: The x_obs_copy_source_server_side_encryption_customer_key of this CopyObjectRequest.
|
|
742
742
|
:type x_obs_copy_source_server_side_encryption_customer_key: str
|
|
@@ -747,7 +747,7 @@ class CopyObjectRequest:
|
|
|
747
747
|
def x_obs_copy_source_server_side_encryption_customer_key_md5(self):
|
|
748
748
|
"""Gets the x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
749
749
|
|
|
750
|
-
SSE-C
|
|
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
|
|
|
752
752
|
:return: The x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
753
753
|
:rtype: str
|
|
@@ -758,7 +758,7 @@ class CopyObjectRequest:
|
|
|
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
759
|
"""Sets the x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
760
760
|
|
|
761
|
-
SSE-C
|
|
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
|
|
|
763
763
|
:param x_obs_copy_source_server_side_encryption_customer_key_md5: The x_obs_copy_source_server_side_encryption_customer_key_md5 of this CopyObjectRequest.
|
|
764
764
|
:type x_obs_copy_source_server_side_encryption_customer_key_md5: str
|
|
@@ -769,7 +769,7 @@ class CopyObjectRequest:
|
|
|
769
769
|
def success_action_redirect(self):
|
|
770
770
|
"""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
|
|
|
774
774
|
:return: The success_action_redirect of this CopyObjectRequest.
|
|
775
775
|
:rtype: str
|
|
@@ -780,7 +780,7 @@ class CopyObjectRequest:
|
|
|
780
780
|
def success_action_redirect(self, success_action_redirect):
|
|
781
781
|
"""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
|
|
|
785
785
|
:param success_action_redirect: The success_action_redirect of this CopyObjectRequest.
|
|
786
786
|
:type success_action_redirect: str
|