modifyDataRetentionPolicy

Back to index

Summary

Modifies the specified dataRetentionPolicy object.

For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.

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.

Possible values: "archiveOnly", "purgeAfterArchive", "purgeOnly"

additionalFilters

Array<AdditionalFilter>optional

Additional filter criteria for the object type similar to search filters.

age

Integeroptional

Minimum age of the data to qualify for the data retention rule.

ageUnit

Stringoptional

Time unit for age.

Possible values: "minutes", "hours", "days", "weeks", "months", "years"

associatedTags

Array<Unknown>optional

List of tags that the object can be associated with.

cleanupAssociatedWorkspace

Booleanoptional

Whether or not to cleanup the associated workspace directory with the job or deployment being purged.

cleanupDatabase

Booleanoptional

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

Booleanoptional

Whether or not to clear additional filters for the data retention policy.

clearAssociatedTags

Booleanoptional

Whether or not to clear associated tags for the data retention policy.

clearProjectNames

Booleanoptional

Whether or not to clear project names for the data retention policy.

clearStatuses

Booleanoptional

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

Booleanoptional

True to enable the data retention policy. Defaults to true when creating the data retention policy.

includeSubreleases

Booleanoptional

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

Integeroptional

Number of objects to retain.

objectType

Stringoptional

Type of object for which the retention rule is defined.

Possible values: "ciBuild", "deployment", "job", "pipelineRun", "release"

projectNames

Array<Unknown>optional

List of projects that the object can belong to.

statuses

Array<Unknown>optional

List of statuses for the object such as job status, release status, pipeline run status, or deployment status.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.modifyDataRetentionPolicy(
  dataRetentionPolicyName: "test-dataRetentionPolicyName"
  /* optional arguments */
)▼