Index
aclaclEntryactualParameteraddCredentialapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

dataRetentionPolicy

On this page
Back to index

Summary

Data Retention Policy.
dataRetentionPolicyName
Stringrequired
Unique name of the data retention policy.
action
Stringoptional
The action to take on the data that matches the criteria for the data retention rule.
additionalFilters
Stringoptional
Additional filter criteria for the object type similar to search filters. (Alternate argument name additionalFilter.)
age
Stringoptional
Minimum age of the data to qualify for the data retention rule.
ageUnit
Stringoptional
Time unit for age.
associatedTags
Stringoptional
List of tags that the object can be associated with. (Alternate argument name associatedTag.)
cleanupAssociatedWorkspace
Stringoptional
Whether or not to cleanup the associated workspace directory with the job or deployment being purged.
cleanupDatabase
Stringoptional
Whether or not to delete the jobs from the database. If set to false, then cleanupAssociatedWorkspace must be set to true for the jobs or deployments being purged.
clearAdditionalFilters
Stringoptional
Whether or not to clear additional filters for the data retention policy.
clearAssociatedTags
Stringoptional
Whether or not to clear associated tags for the data retention policy.
clearProjectNames
Stringoptional
Whether or not to clear project names for the data retention policy.
clearStatuses
Stringoptional
Whether or not to clear statuses for the data retention policy.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled
Stringoptional
True to enable the data retention policy. Defaults to true when creating the data retention policy.
includeSubreleases
Stringoptional
When set to true subreleases will be automatically included for releases matching the data retention rule. Defaults to false.
newName
Stringoptional
The new name for an existing object that is being renamed.
numberToRetain
Stringoptional
Number of objects to retain.
objectType
Stringoptional
Type of object for which the retention rule is defined.
projectNames
Stringoptional
List of projects that the object can belong to. (Alternate argument name projectName.)
statuses
Stringoptional
List of statuses for the object such as job status, release status, pipeline run status, or deployment status. (Alternate argument name status.)

Usage

There are no usage examples available for dataRetentionPolicy.