Table of Contents

Class JobTriggerTarget

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

Represents a target for a JobTrigger

[ComVisible(true)]
[Guid("4C96F53B-2A57-45F1-9230-636571D297B5")]
public sealed class JobTriggerTarget : ADTObject
Inheritance
object
JobTriggerTarget

Properties

AgentMatchRule

Determines how the trigger treats jobs running on 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.

Enabled

Indicates whether this target is enabled.

public bool Enabled { get; set; }

Property Value

bool

Remarks

If the target is disabled (Enabled set to false) it is ignored.

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.

TargetComputer

The name of the adTempus server the target job runs on

public string TargetComputer { get; set; }

Property Value

string

TargetInstance

Determines which instance(s) of the TargetJob the trigger looks 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

TargetJobOID

The OID of the target job.

public OID TargetJobOID { get; set; }

Property Value

OID

Remarks

See Remarks under TargetJob

See Also

TargetOptions

Additional options for this target

public JobTriggerTargetOptions TargetOptions { get; set; }

Property Value

JobTriggerTargetOptions

TargetServerID

The adTempus instance ID for the target computer. Required if TargetComputer is set.

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

Property Value

Guid?

TargetVariable

The name of the variable to match against when the TargetInstance uses a variable

public string TargetVariable { get; set; }

Property Value

string

TriggerType

Specifies the action this target will watch for on the TargetJob

public JobTriggerType TriggerType { get; set; }

Property Value

JobTriggerType

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