Send feedback
Buckets: lockRetentionPolicy
Stay organized with collections
Save and categorize content based on your preferences.
Permanently locks the retention policy that is
currently applied to the specified bucket.
Caution : Locking a bucket is an irreversible action. Once
you lock a bucket:
You cannot remove the retention policy from the bucket.
You cannot decrease the retention period for the policy. Once locked, you must delete the entire bucket in order to "remove" the bucket's
retention policy. However, before you can delete the bucket, you must be
able to delete all the objects in the bucket, which itself is only possible
if the all objects have reached the retention period set by the retention policy.
Required permissions
The authenticated user must have the storage.buckets.update IAM
permission to use this method.
Request
HTTP request
POST https://storage.googleapis.com/storage/v1/b/bucket /lockRetentionPolicy In addition to standard query parameters ,
the following query parameters apply to this method.
To see an example of how to include query parameters in a request, see the
JSON API Overview page.
Parameters
Parameter name
Value
Description
Path parameters
bucketstring
Name of a bucket.
Required query parameters
ifMetagenerationMatchlong
Makes the success of the request conditional on whether the bucket's current
metageneration matches the given value.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a bucket
resource in the response body.
For information about status and error codes returned by this API, see the
reference page .
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
Need to tell us more?
[[["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 2024-11-14 UTC."],[],[]]
