Table of Contents

Class JobCondition

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

Condition that depends on the state or outcome of one or more other jobs

public sealed class JobCondition : Condition
Inheritance
object
JobCondition

Properties

AgentMatchRule

Rules for selecting target instances when the job runs on remote agents

public AgentMatchRule AgentMatchRule { get; set; }

Property Value

AgentMatchRule

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.

ConditionType

Defines the job state that will satisfy the condition

public JobConditionType ConditionType { get; set; }

Property Value

JobConditionType

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.

Options

Additional options for the condition

public JobConditionOptions Options { get; set; }

Property Value

JobConditionOptions

TargetComputer

Specifies the computer where the jobs are running, if other than the computer where the current job runs

public string TargetComputer { get; set; }

Property Value

string

TargetInstance

Specifies which instance(s) of the target job to look at

public JobConditionInstance TargetInstance { get; set; }

Property Value

JobConditionInstance

TargetJob

The job the condition targets

public Job TargetJob { get; set; }

Property Value

Job

Remarks

When TargetServerID is set, the TargetJob may be null. In that case you can obtain the identity and name from the TargetJobOID and TargetJobName. If you need a reference to the job, you must make a separate connection to the TargetComputer and retrieve the job.

If the target job is on a different adTempus instance, setting TargetJob automatically sets the TargetJobOID, TargetServerID, and TargetComputer.

TargetJobName

The name of the target job. Stored only when the target job is on a remote computer.

public string TargetJobName { get; set; }

Property Value

string

Remarks

The name is only stored so that it can be displayed to users in the description of the condition. The TargetJobOID is what is actually used to locate the job. If the job is renamed on the target server, the TargetJobName is not automatically updated, but the condition will still link to the correct job.

TargetJobOID

The OID of the target job.

public OID TargetJobOID { get; set; }

Property Value

OID

Remarks

See Remarks under TargetJob

See Also

TargetServerID

The adTempus instance ID for the target computer. Required if cref="TargetComputer"/> is set.

[ComVisible(false)]
public Guid? TargetServerID { get; set; }

Property Value

Guid?

Remarks

This value can be obtained from InstanceID in the session connected to the remote computer.

Do not set this value for a local condition (when TargetComputer is not set).

TargetVariable

The target job variable for this condition

public string TargetVariable { get; set; }

Property Value

string

Methods

GetConditionDescription() 

protected override string GetConditionDescription()

Returns

string

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