Interface RetentionLease

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

interface RetentionLease {
    createdOn?: Date;
    definitionId?: number;
    leaseId?: number;
    ownerId?: string;
    protectPipeline?: boolean;
    runId?: number;
    validUntil?: Date;
}

Properties

createdOn? definitionId? leaseId? ownerId? protectPipeline? runId? validUntil?

Properties

OptionalcreatedOn

createdOn?: Date

When the lease was created.

OptionaldefinitionId

definitionId?: number

The pipeline definition of the run.

OptionalleaseId

leaseId?: number

The unique identifier for this lease.

OptionalownerId

ownerId?: string

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

OptionalprotectPipeline

protectPipeline?: boolean

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

OptionalrunId

runId?: number

The pipeline run protected by this lease.

OptionalvalidUntil

validUntil?: Date

The last day the lease is considered valid.

Settings

Member Visibility

On This Page

Properties