Stay organized with collections Save and categorize content based on your preferences.
To get an object's retention configuration you make a GET request that is scoped to the object, and you use the retention
query string parameter. If the object has a retention configuration, the configuration is returned in an XML document in the response body. Otherwise, the request fails with a 404 Not Found
response.
You must have READ
permission to get an object's retention configuration.
See signed URL query string parameters for information on the parameters you include when creating and using signed URLs.
Request body elementsThis request does not include an XML document in the request body.
Request syntaxThe following syntax applies to GET Object requests that use the retention
query string parameter.
GET /OBJECT_NAME?retention&generation=GENERATION HTTP/1.1 Host: BUCKET_NAME.storage.googleapis.com Content-Length: 0 Content-Type: TYPE Authorization: AUTHENTICATION_STRING
The request can return a variety of response headers depending on the request headers you use.
Response body elementsThe following response body elements are applicable only if you use the retention
query string parameter.
Retention
Container for an object's retention configuration. Mode
Mode of the object retention configuration. GOVERNANCE
corresponds to unlocked mode, and COMPLIANCE
corresponds to locked mode. RetainUntilDate
A date and time represented in RFC 3339 UTC format that indicates the time until which the object is retained as immutable. Examples
The following example retrieves the retention configuration for an object named tokyo.jpg
.
Request
GET /tokyo.jpg?retention HTTP/1.1 Host: travel-maps.storage.googleapis.com Content-Length: 0 Authorization: Bearer ya29.AHES6ZRVmB7fkLtd1XTmq6mo0S1wqZZi3-Lh_s-6Uw7p8vtgSwg
Response
HTTP/1.1 200 OK Content-Length: 138 Content-Type: application/xml; charset=UTF-8 Date: Tue, 01 Nov 2016 17:12:32 GMT <?xml version="1.0" encoding="UTF-8"?> <Retention> <Mode> GOVERNANCE </Mode> <RetainUntilDate> 2028-04-12T23:20:00Z </RetainUntilDate> </Retention>
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 2025-08-07 UTC.
[[["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-07 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4