With the HTTP protocol, retention information is returned by HTTP response headers. With the WebDAV, CIFS, and NFS protocols, you view retention information for an object in the retention.txt metafile.
Retention information returned through HTTP
When you use HTTP to retrieve metadata for an object, the returned header information includes four retention-related values, as shown in the table below.
Header | Value |
---|---|
X-HCP-Retention |
One of: •The retention setting expressed as a number of seconds since January 1, 1970, at 00:00:00 UTC •One of the special values 0, -1, or -2 |
X-HCP-RetentionString |
One of: •The retention period end time expressed as a datetime value in the format described in Specifying a date and time •One of the special values Deletion Allowed, Deletion Prohibited, or Initial Unspecified |
X-HCP-RetentionClass |
The retention class of the object or an empty string if the object is not assigned to a retention class. The information is returned in this format: (retention-class-name, retention-class- If the retention class is deleted, retention-class-value is undefined. |
X-HCP-RetentionHold |
A value of true or false that indicates whether the object is on hold. |
retention.txt settings for an object
The table below shows the possible retention settings in the retention.txt metafile for an object.
0 |
|
0 |
0 |
-1 |
|
-1 |
-1 |
-2 |
|
-2 |
-2 |
retention-period-end-seconds-past-1970-1-1 retention-period-end-datetime |
retention-period-end-seconds-past-1970-1-1 |
retention-period-end-seconds-past-1970-1-1 |
retention-period-end-seconds-past-1970-1-1 |
retention.txt settings for deleted retention classes
If the retention class assigned to an object is deleted, the retention.txt metafile for the object then contains:
•A retention setting of Deletion Prohibited (-1)
•The name of the deleted retention class
•A retention class value of undefined
For example, suppose you assign an object to the HlthReg-107 retention class and then the class is deleted. The retention.txt metafile for the object then contains:
-1
Deletion Prohibited (HlthReg-107, undefined)
© 2017 Hitachi Data Systems Corporation. All rights reserved.