Table of Contents

Class QueueAgentJoin

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Represents a link between a JobQueue and a RemoteAgent

public sealed class QueueAgentJoin : ADTObject
Inheritance
object
QueueAgentJoin

Remarks

To target a JobQueue to a RemoteAgent, create a QueueAgentJoin linking the two and add it to the JobQueue's Agents collection.

The QueueAgentJoin cannot be saved directly: you must save either the JobQueue or RemoteAgent after associating the join with them.

Properties

Agent

The RemoteAgent for this join

public RemoteAgent Agent { get; set; }

Property Value

RemoteAgent

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

Enabled

Indicates whether this Agent is enabled for the queue.

public bool Enabled { get; set; }

Property Value

bool

Remarks

If the QueueAgentJoin is not enabled, jobs in the queue will not be sent to this agent.

ExecutionType

The options supported by the RemoteAgent

public RemoteAgentOptions ExecutionType { get; set; }

Property Value

RemoteAgentOptions

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

JobQueue

The JobQueue this link belongs to

public JobQueue JobQueue { get; set; }

Property Value

JobQueue

MaxConcurrentJobs

The maximum number of jobs that can run concurrently on this agent for this queue.

public int MaxConcurrentJobs { get; set; }

Property Value

int

Remarks

Set to 0 for no limit.

Priority

The priority to use when assigning jobs to agents

public int Priority { get; set; }

Property Value

int

Remarks

Set to 0 to ignore priority. Jobs are assigned to agents with higher priority before agents with lower priority.

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members