Interface TaskAgentJobRequest

A job request for an agent.

interface TaskAgentJobRequest {
    agentSpecification?: any;
    assignTime?: Date;
    data?: { [key: string]: string };
    definition?: TaskOrchestrationOwner;
    demands?: Demand[];
    finishTime?: Date;
    hostId?: string;
    jobId?: string;
    jobName?: string;
    lockedUntil?: Date;
    matchedAgents?: TaskAgentReference[];
    matchesAllAgentsInPool?: boolean;
    orchestrationId?: string;
    owner?: TaskOrchestrationOwner;
    planGroup?: string;
    planId?: string;
    planType?: string;
    poolId?: number;
    priority?: number;
    queueId?: number;
    queueTime?: Date;
    receiveTime?: Date;
    requestId?: number;
    reservedAgent?: TaskAgentReference;
    result?: TaskResult;
    scopeId?: string;
    serviceOwner?: string;
    statusMessage?: string;
    userDelayed?: boolean;
}

Properties

agentSpecification? assignTime? data? definition? demands? finishTime? hostId? jobId? jobName? lockedUntil? matchedAgents? matchesAllAgentsInPool? orchestrationId? owner? planGroup? planId? planType? poolId? priority? queueId? queueTime? receiveTime? requestId? reservedAgent? result? scopeId? serviceOwner? statusMessage? userDelayed?

Properties

OptionalagentSpecification

agentSpecification?: any

OptionalassignTime

assignTime?: Date

The date/time this request was assigned.

Optionaldata

data?: { [key: string]: string }

Additional data about the request.

Optionaldefinition

definition?: TaskOrchestrationOwner

The pipeline definition associated with this request

Optionaldemands

demands?: Demand[]

A list of demands required to fulfill this request.

OptionalfinishTime

finishTime?: Date

The date/time this request was finished.

OptionalhostId

hostId?: string

The host which triggered this request.

OptionaljobId

jobId?: string

ID of the job resulting from this request.

OptionaljobName

jobName?: string

Name of the job resulting from this request.

OptionallockedUntil

lockedUntil?: Date

The deadline for the agent to renew the lock.

OptionalmatchedAgents

matchedAgents?: TaskAgentReference[]

OptionalmatchesAllAgentsInPool

matchesAllAgentsInPool?: boolean

OptionalorchestrationId

orchestrationId?: string

Optionalowner

owner?: TaskOrchestrationOwner

The pipeline associated with this request

OptionalplanGroup

planGroup?: string

OptionalplanId

planId?: string

Internal ID for the orchestration plan connected with this request.

OptionalplanType

planType?: string

Internal detail representing the type of orchestration plan.

OptionalpoolId

poolId?: number

The ID of the pool this request targets

Optionalpriority

priority?: number

OptionalqueueId

queueId?: number

The ID of the queue this request targets

OptionalqueueTime

queueTime?: Date

The date/time this request was queued.

OptionalreceiveTime

receiveTime?: Date

The date/time this request was receieved by an agent.

OptionalrequestId

requestId?: number

ID of the request.

OptionalreservedAgent

reservedAgent?: TaskAgentReference

The agent allocated for this request.

Optionalresult

result?: TaskResult

The result of this request.

OptionalscopeId

scopeId?: string

Scope of the pipeline; matches the project ID.

OptionalserviceOwner

serviceOwner?: string

The service which owns this request.

OptionalstatusMessage

statusMessage?: string

OptionaluserDelayed

userDelayed?: boolean

Settings

Member Visibility

On This Page

Properties