(Optional) The period of time in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.
effective_time
datetime.datetime
(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
Bucket
the instance's bucket.
effective_time
Get the effective time of the bucket's soft delete policy.
Returns
Type
Description
datetime.datetime or NoneType
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 NoneType
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
SoftDeletePolicy
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-12 UTC."],[],[],null,["# Class SoftDeletePolicy (3.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.3.0 (latest)](/python/docs/reference/storage/latest/google.cloud.storage.bucket.SoftDeletePolicy)\n- [3.2.0](/python/docs/reference/storage/3.2.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [3.1.1](/python/docs/reference/storage/3.1.1/google.cloud.storage.bucket.SoftDeletePolicy)\n- [3.0.0](/python/docs/reference/storage/3.0.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.19.0](/python/docs/reference/storage/2.19.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.17.0](/python/docs/reference/storage/2.17.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.16.0](/python/docs/reference/storage/2.16.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.15.0](/python/docs/reference/storage/2.15.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.14.0](/python/docs/reference/storage/2.14.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.13.0](/python/docs/reference/storage/2.13.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.12.0](/python/docs/reference/storage/2.12.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.11.0](/python/docs/reference/storage/2.11.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.10.0](/python/docs/reference/storage/2.10.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.9.0](/python/docs/reference/storage/2.9.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.8.0](/python/docs/reference/storage/2.8.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.7.0](/python/docs/reference/storage/2.7.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.6.0](/python/docs/reference/storage/2.6.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.5.0](/python/docs/reference/storage/2.5.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.4.0](/python/docs/reference/storage/2.4.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.3.0](/python/docs/reference/storage/2.3.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.2.1](/python/docs/reference/storage/2.2.1/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.1.0](/python/docs/reference/storage/2.1.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [2.0.0](/python/docs/reference/storage/2.0.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.44.0](/python/docs/reference/storage/1.44.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.43.0](/python/docs/reference/storage/1.43.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.42.3](/python/docs/reference/storage/1.42.3/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.41.1](/python/docs/reference/storage/1.41.1/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.40.0](/python/docs/reference/storage/1.40.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.39.0](/python/docs/reference/storage/1.39.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.38.0](/python/docs/reference/storage/1.38.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.37.1](/python/docs/reference/storage/1.37.1/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.36.2](/python/docs/reference/storage/1.36.2/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.35.1](/python/docs/reference/storage/1.35.1/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.34.0](/python/docs/reference/storage/1.34.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.33.0](/python/docs/reference/storage/1.33.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.32.0](/python/docs/reference/storage/1.32.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.31.2](/python/docs/reference/storage/1.31.2/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.30.0](/python/docs/reference/storage/1.30.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.29.0](/python/docs/reference/storage/1.29.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.28.1](/python/docs/reference/storage/1.28.1/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.27.0](/python/docs/reference/storage/1.27.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.26.0](/python/docs/reference/storage/1.26.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.25.0](/python/docs/reference/storage/1.25.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.24.1](/python/docs/reference/storage/1.24.1/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.23.0](/python/docs/reference/storage/1.23.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.22.0](/python/docs/reference/storage/1.22.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.21.0](/python/docs/reference/storage/1.21.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.20.0](/python/docs/reference/storage/1.20.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.19.0](/python/docs/reference/storage/1.19.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.18.0](/python/docs/reference/storage/1.18.0/google.cloud.storage.bucket.SoftDeletePolicy)\n- [1.17.0](/python/docs/reference/storage/1.17.0/google.cloud.storage.bucket.SoftDeletePolicy) \n\n SoftDeletePolicy(bucket, **kw)\n\nMap a bucket's soft delete policy.\n\nSee \u003chttps://cloud.google.com/storage/docs/soft-delete\u003e\n\nProperties\n----------\n\n### bucket\n\nBucket for which this instance is the policy.\n\n### effective_time\n\nGet the effective time of the bucket's soft delete policy.\n\n### retention_duration_seconds\n\nGet the retention duration of the bucket's soft delete policy.\n\nMethods\n-------\n\n### clear\n\n clear()\n\nAPI documentation for `storage.bucket.SoftDeletePolicy.clear` method.\n\n### copy\n\n copy()\n\nAPI documentation for `storage.bucket.SoftDeletePolicy.copy` method.\n\n### from_api_repr\n\n from_api_repr(resource, bucket)\n\nFactory: construct instance from resource.\n\n### fromkeys\n\n fromkeys(value=None, /)\n\nCreate a new dictionary with keys from iterable and values set to value.\n\n### get\n\n get(key, default=None, /)\n\nReturn the value for key if key is in the dictionary, else default.\n\n### items\n\n items()\n\nAPI documentation for `storage.bucket.SoftDeletePolicy.items` method.\n\n### keys\n\n keys()\n\nAPI documentation for `storage.bucket.SoftDeletePolicy.keys` method.\n\n### pop\n\n pop(k[,d])\n\nIf the key is not found, return the default if given; otherwise,\nraise a KeyError.\n\n### popitem\n\n popitem()\n\nRemove and return a (key, value) pair as a 2-tuple.\n\nPairs are returned in LIFO (last-in, first-out) order.\nRaises KeyError if the dict is empty.\n\n### setdefault\n\n setdefault(key, default=None, /)\n\nInsert key with a value of default if key is not in the dictionary.\n\nReturn the value for key if key is in the dictionary, else default.\n\n### update\n\n update([E, ]**F)\n\nIf E is present and has a .keys() method, then does: for k in E: D\\[k\\] = E\\[k\\]\nIf E is present and lacks a .keys() method, then does: for k, v in E: D\\[k\\] = v\nIn either case, this is followed by: for k in F: D\\[k\\] = F\\[k\\]\n\n### values\n\n values()\n\nAPI documentation for `storage.bucket.SoftDeletePolicy.values` method."]]