Back to index
Summary
Modifies the specifieddataRetentionPolicy
object.dataRetentionPolicyNameStringrequiredUnique name of the data retention policy. actionStringoptionalThe action to take on the data that matches the criteria for the data retention rule. Possible values: "archiveOnly" , "purgeAfterArchive" , "purgeOnly" additionalFiltersStringoptionalAdditional filter criteria for the object type similar to search filters. ageIntegeroptionalMinimum age of the data to qualify for the data retention rule. ageUnitStringoptionalTime unit for age. Possible values: "minutes" , "hours" , "days" , "weeks" , "months" , "years" associatedTagsStringoptionalList of tags that the object can be associated with. cleanupAssociatedWorkspaceBooleanoptionalWhether or not to cleanup the associated workspace directory with the job or deployment being purged. cleanupDatabaseBooleanoptionalWhether 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.clearAdditionalFiltersBooleanoptionalWhether or not to clear additional filters for the data retention policy. clearAssociatedTagsBooleanoptionalWhether or not to clear associated tags for the data retention policy. clearProjectNamesBooleanoptionalWhether or not to clear project names for the data retention policy. clearStatusesBooleanoptionalWhether or not to clear statuses for the data retention policy. descriptionStringoptionalComment text describing this object that is not interpreted at all by CloudBees CD/RO. enabledBooleanoptionalTrue to enable the data retention policy. Defaults to true when creating the data retention policy. includeSubreleasesBooleanoptionalIf the data retention rule is defined for releases, then whether to automatically include the subreleases for the releases matching the data retention rule. Defaults to false. newNameStringoptionalThe new name for an existing object that is being renamed. objectTypeStringoptionalType of object for which the retention rule is defined. Possible values: "ciBuild" , "deployment" , "job" , "pipelineRun" , "release" projectNamesStringoptionalList of projects that the object can belong to. statusesStringoptionalList of statuses for the object such as job status, release status, pipeline run status, or deployment status. |
Usage
Perl
$cmdr->modifyDataRetentionPolicy( "test-dataRetentionPolicyName" # dataRetentionPolicyName # optionals );
ectool
ectool modifyDataRetentionPolicy \ "test-dataRetentionPolicyName" `# dataRetentionPolicyName` \ # optionals