versioningSettings
The versioningSettings
data type describes the versioningSettings
resource for namespaces and the versioningSettings
property of the namespace and namespaceDefaults data types.
Properties
The table below describes the properties included in the versioningSettings
data type.
Property | Data type | Description | Notes |
daysOnPrimary | Integer |
Specifies the number of days old versions of objects must remain in the namespace before they are pruned. Valid values are integers in the range zero through 36,500 (that is, 100 years). A value of zero means prune immediately. The default is zero. |
Deprecated; replaced by the If specified on a PUT or POST request, this property has the same function as the This property is not returned by any GET request. |
daysOnReplica | Integer |
Deprecated. The pruneDays property applies to the namespace on all systems on which the namespace exists. This property is ignored on a PUT or POST request and is not returned by any GET request. | |
enabled | Boolean |
Specifies whether versioning is enabled for the namespace. Valid values are:
The default is false. |
This property is required on a PUT request to create a namespace and on a POST request to modify namespace defaults if the request includes the You cannot enable versioning for a namespace while the CIFS, NFS, WebDAV, or SMTP protocol or appendable objects are enabled. |
keepDeletionRecords | Boolean |
Specifies whether HCP should keep records of deletion operations (delete, purge, prune, disposition) that occur in the namespace if the namespace has ever had versioning enabled. Valid values are:
The default is true. The amount of time for which HCP keeps deletion records is determined by the system configuration. | This property is not valid on a POST request to modify namespace defaults and is not returned by any GET request for namespace defaults. |
prune | Boolean |
Specifies whether version pruning is enabled for the namespace. Valid values are:
The default is false. |
This property is required on a PUT request to create a namespace and on a POST request to modify namespace defaults if the enabled property is set to You cannot include both this property and the |
pruneDays | Integer |
Specifies the number of days old versions of objects must remain in the namespace before they are pruned. Valid values are integers in the range zero through 36,500 (that is, 100 years). A value of zero means prune immediately. The default is zero. |
This property is required on a PUT request to create a namespace and on a POST request to modify namespace defaults if the prune property is set to You cannot include both this property and the |
pruneOnPrimary | Boolean |
Specifies whether version pruning is enabled for the namespace. Valid values are:
The default is false. |
Deprecated; replaced by the prune property. If specified on a PUT or POST request, this property has the same function as the This property is not returned by any GET request. |
pruneOnReplica | Boolean |
Deprecated. The prune property applies to the namespace on all systems on which the namespace exists. This property is ignored on a PUT or POST request and is not returned by any GET request. |
Example
Here’s an XML example of the versioningSettings
data type:
<versioningSettings> <enabled>true</enabled> <keepDeletionRecords>true</keepDeletionRecords> <prune>true</prune> <pruneDays>10</pruneDays> </versioningSettings>