Edit

Share via


RetentionLease interface

A valid retention lease prevents automated systems from deleting a pipeline run.

Properties

createdOn

When the lease was created.

definitionId

The pipeline definition of the run.

leaseId

The unique identifier for this lease.

ownerId

Non-unique string that identifies the owner of a retention lease.

protectPipeline

If set, this lease will also prevent the pipeline from being deleted while the lease is still valid.

runId

The pipeline run protected by this lease.

validUntil

The last day the lease is considered valid.

Property Details

createdOn

When the lease was created.

createdOn: Date

Property Value

Date

definitionId

The pipeline definition of the run.

definitionId: number

Property Value

number

leaseId

The unique identifier for this lease.

leaseId: number

Property Value

number

ownerId

Non-unique string that identifies the owner of a retention lease.

ownerId: string

Property Value

string

protectPipeline

If set, this lease will also prevent the pipeline from being deleted while the lease is still valid.

protectPipeline: boolean

Property Value

boolean

runId

The pipeline run protected by this lease.

runId: number

Property Value

number

validUntil

The last day the lease is considered valid.

validUntil: Date

Property Value

Date