RetentionLease interface
A valid retention lease prevents automated systems from deleting a pipeline run.
Properties
| created |
When the lease was created. |
| definition |
The pipeline definition of the run. |
| lease |
The unique identifier for this lease. |
| owner |
Non-unique 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 protected by this lease. |
| valid |
The last day the lease is considered valid. |
Property Details
createdOn
When the lease was created.
createdOn: DateProperty Value
Date
definitionId
The pipeline definition of the run.
definitionId: numberProperty Value
number
leaseId
The unique identifier for this lease.
leaseId: numberProperty Value
number
ownerId
Non-unique 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 protected by this lease.
runId: numberProperty Value
number
validUntil
The last day the lease is considered valid.
validUntil: DateProperty Value
Date