TaskAgentJobRequest interface
A job request for an agent.
- Extends
Properties
| agent |
|
| data | Additional data about the request. |
| definition | The pipeline definition associated with this request |
| demands | A list of demands required to fulfill this request. |
| host |
The host which triggered this request. |
| job |
ID of the job resulting from this request. |
| job |
Name of the job resulting from this request. |
| locked |
The deadline for the agent to renew the lock. |
| matched |
|
| matches |
|
| owner | The pipeline associated with this request |
| plan |
|
| plan |
Internal ID for the orchestration plan connected with this request. |
| plan |
Internal detail representing the type of orchestration plan. |
| pool |
The ID of the pool this request targets |
| priority | |
| queue |
The ID of the queue this request targets |
| reserved |
The agent allocated for this request. |
| result | The result of this request. |
| scope |
Scope of the pipeline; matches the project ID. |
| service |
The service which owns this request. |
| status |
|
| user |
Inherited Properties
| assign |
The date/time this request was assigned. |
| finish |
The date/time this request was finished. |
| orchestration |
|
| queue |
The date/time this request was queued. |
| receive |
The date/time this request was receieved by an agent. |
| request |
ID of the request. |
Property Details
agentSpecification
agentSpecification: anyProperty Value
any
data
Additional data about the request.
data: {[key: string]: string}Property Value
{[key: string]: string}
definition
The pipeline definition associated with this request
definition: TaskOrchestrationOwnerProperty Value
demands
hostId
The host which triggered this request.
hostId: stringProperty Value
string
jobId
ID of the job resulting from this request.
jobId: stringProperty Value
string
jobName
Name of the job resulting from this request.
jobName: stringProperty Value
string
lockedUntil
The deadline for the agent to renew the lock.
lockedUntil: DateProperty Value
Date
matchedAgents
matchesAllAgentsInPool
matchesAllAgentsInPool: booleanProperty Value
boolean
owner
The pipeline associated with this request
owner: TaskOrchestrationOwnerProperty Value
planGroup
planGroup: stringProperty Value
string
planId
Internal ID for the orchestration plan connected with this request.
planId: stringProperty Value
string
planType
Internal detail representing the type of orchestration plan.
planType: stringProperty Value
string
poolId
The ID of the pool this request targets
poolId: numberProperty Value
number
priority
priority: numberProperty Value
number
queueId
The ID of the queue this request targets
queueId: numberProperty Value
number
reservedAgent
The agent allocated for this request.
reservedAgent: TaskAgentReferenceProperty Value
result
scopeId
Scope of the pipeline; matches the project ID.
scopeId: stringProperty Value
string
serviceOwner
The service which owns this request.
serviceOwner: stringProperty Value
string
statusMessage
statusMessage: stringProperty Value
string
userDelayed
userDelayed: booleanProperty Value
boolean
Inherited Property Details
assignTime
The date/time this request was assigned.
assignTime: DateProperty Value
Date
Inherited From TaskAgentJobRequestRef.assignTime
finishTime
The date/time this request was finished.
finishTime: DateProperty Value
Date
Inherited From TaskAgentJobRequestRef.finishTime
orchestrationId
queueTime
The date/time this request was queued.
queueTime: DateProperty Value
Date
Inherited From TaskAgentJobRequestRef.queueTime
receiveTime
The date/time this request was receieved by an agent.
receiveTime: DateProperty Value
Date
Inherited From TaskAgentJobRequestRef.receiveTime
requestId
ID of the request.
requestId: numberProperty Value
number
Inherited From TaskAgentJobRequestRef.requestId