Interface ResourceLockRequest

A request for a resource's exclusive lock

interface ResourceLockRequest {
    assignTime?: Date;
    branch?: string;
    checkRunId?: string;
    definitionId?: number;
    finishTime?: Date;
    lockType?: ExclusiveLockType;
    nodeAttempt?: number;
    nodeName?: string;
    planId?: string;
    projectId?: string;
    queueTime?: Date;
    requestId?: number;
    resourceId?: string;
    resourceType?: string;
    status?: ResourceLockStatus;
}

Properties

assignTime? branch? checkRunId? definitionId? finishTime? lockType? nodeAttempt? nodeName? planId? projectId? queueTime? requestId? resourceId? resourceType? status?

Properties

OptionalassignTime

assignTime?: Date

The date/time this request was assigned.

Optionalbranch

branch?: string

The branch the lock belongs to. It's used only by RunLatest exclusive locks of persisted stages.

OptionalcheckRunId

checkRunId?: string

The ID of the check run waiting on this request

OptionaldefinitionId

definitionId?: number

The ID of the pipeline that requested this resource

OptionalfinishTime

finishTime?: Date

The date/time this request was finished.

OptionallockType

lockType?: ExclusiveLockType

The behavior this request should exhibit in relation to other lock requests

OptionalnodeAttempt

nodeAttempt?: number

Attempt of the graph node

OptionalnodeName

nodeName?: string

Name of the graph node (currently stage) requesting this resource

OptionalplanId

planId?: string

Internal ID for the orchestration plan connected with this request.

OptionalprojectId

projectId?: string

The ID of the project of the check run and definition exist in

OptionalqueueTime

queueTime?: Date

The date/time this request was queued.

OptionalrequestId

requestId?: number

ID of the request.

OptionalresourceId

resourceId?: string

The id of the resource

OptionalresourceType

resourceType?: string

The type of the resource

Optionalstatus

status?: ResourceLockStatus

The result of this request.

Settings

Member Visibility

On This Page

Properties