RetentionLease interface
A valid retention lease prevents automated systems from deleting a pipeline run.
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. |
When the lease was created.
createdOn: Date
Property Value
Date
The pipeline definition of the run.
definitionId: number
Property Value
number
The unique identifier for this lease.
leaseId: number
Property Value
number
Non-unique string that identifies the owner of a retention lease.
ownerId: string
Property Value
string
If set, this lease will also prevent the pipeline from being deleted while the lease is still valid.
protectPipeline: boolean
Property Value
boolean
The pipeline run protected by this lease.
runId: number
Property Value
number
The last day the lease is considered valid.
validUntil: Date
Property Value
Date