A retention class is a named retention value that, when used as the retention setting for an object, specifies how long the object must remain in the repository. This value can be:
•A duration after object creation. For example, a retention class named HlthReg-107 could have a duration of 21 years. All objects that have that class as their retention setting could not be deleted for 21 years after they’re created.
•One of these special values:
oDeletion Allowed (0)
oDeletion Prohibited (-1)
oInitial Unspecified (-2)
Retention class duration values use this format:
A+yearsy+monthsM+daysd
In this format, A represents the time at which the object was created. For example, this value specifies a retention period of one year, two months, and three days:
A+1y+2M+3d
The duration specification can omit portions with zero values. For example, this value specifies a six-month retention period:
A+6M
You can use retention classes to consistently manage data that must conform to a specific retention rule. For example, if local law requires that medical records be kept for a specific number of years, you can use a retention class to enforce that requirement.
![]() |
Note: Automatic deletion must be enabled for the namespace for objects under retention to be automatically deleted. For more information about automatic deletion, see Retention. |
Each namespace has its own set of retention classes. You cannot apply a retention class defined in one namespace to an object in a different namespace.
Retention classes cannot be configured using the S3 compatible API.
For information about viewing the retention class list in the Namespace Browser, see Viewing retention classes.
© 2015, 2020 Hitachi Vantara LLC. All rights reserved.