Class SoftDeletePolicy (3.2.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 3.5.0 (latest)
- 3.4.1
- 3.3.1
- 3.2.0
- 3.1.1
- 3.0.0
- 2.19.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.1
- 2.1.0
- 2.0.0
- 1.44.0
- 1.43.0
- 1.42.3
- 1.41.1
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.1
- 1.36.2
- 1.35.1
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.2
- 1.30.0
- 1.29.0
- 1.28.1
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
SoftDeletePolicy(bucket, **kw)Map a bucket's soft delete policy.
Parameters |
|
|---|---|
| Name | Description |
bucket |
Bucket for which this instance is the policy. |
retention_duration_seconds |
int
(Optional) The period of time in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. |
effective_time |
(Optional) When the bucket's soft delete policy is effective. This value should normally only be set by the back-end API. |
Properties
bucket
Bucket for which this instance is the policy.
| Returns | |
|---|---|
| Type | Description |
|
the instance's bucket. |
effective_time
Get the effective time of the bucket's soft delete policy.
| Returns | |
|---|---|
| Type | Description |
datetime.datetime or |
point-in time at which the bucket's soft delte policy is effective, or None if the property is not set. |
retention_duration_seconds
Get the retention duration of the bucket's soft delete policy.
| Returns | |
|---|---|
| Type | Description |
int or |
The period of time in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted; Or None if the property is not set. |
Methods
clear
clear()API documentation for storage.bucket.SoftDeletePolicy.clear method.
copy
copy()API documentation for storage.bucket.SoftDeletePolicy.copy method.
from_api_repr
from_api_repr(resource, bucket)Factory: construct instance from resource.
| Parameter | |
|---|---|
| Name | Description |
resource |
dict
mapping as returned from API call. |
| Returns | |
|---|---|
| Type | Description |
|
Instance created from resource. |
fromkeys
fromkeys(value=None, /)Create a new dictionary with keys from iterable and values set to value.
get
get(key, default=None, /)Return the value for key if key is in the dictionary, else default.
items
items()API documentation for storage.bucket.SoftDeletePolicy.items method.
keys
keys()API documentation for storage.bucket.SoftDeletePolicy.keys method.
pop
pop(k[,d])If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem
popitem()Remove and return a (key, value) pair as a 2-tuple.
Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.
setdefault
setdefault(key, default=None, /)Insert key with a value of default if key is not in the dictionary.
Return the value for key if key is in the dictionary, else default.
update
update([E, ]**F)If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values
values()API documentation for storage.bucket.SoftDeletePolicy.values method.