NewRetentionLease interface
Required information to create a new retention lease.
Properties
| days |
The number of days to consider the lease valid. A retention lease valid for more than 100 years (36500 days) will display as retaining the build "forever". |
| definition |
The pipeline definition of the run. |
| owner |
User-provided string that identifies the owner of a retention lease. |
| protect |
If set, this lease will also prevent the pipeline from being deleted while the lease is still valid. |
| run |
The pipeline run to protect. |
Property Details
daysValid
The number of days to consider the lease valid. A retention lease valid for more than 100 years (36500 days) will display as retaining the build "forever".
daysValid: numberProperty Value
number
definitionId
The pipeline definition of the run.
definitionId: numberProperty Value
number
ownerId
User-provided string that identifies the owner of a retention lease.
ownerId: stringProperty Value
string
protectPipeline
If set, this lease will also prevent the pipeline from being deleted while the lease is still valid.
protectPipeline: booleanProperty Value
boolean
runId
The pipeline run to protect.
runId: numberProperty Value
number