Table of Contents

Class JobExecutionTaskTarget

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class JobExecutionTaskTarget : ADTObject, ISupportJobVariables
Inheritance
object
JobExecutionTaskTarget
Implements

Properties

AuthorizationToken 

public string AuthorizationToken { get; set; }

Property Value

string

AuthorizingLoginOID 

public Guid? AuthorizingLoginOID { get; set; }

Property Value

Guid?

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 

public bool Enabled { get; set; }

Property Value

bool

ExecutionOptions 

public JobExecutionOptions? ExecutionOptions { get; set; }

Property Value

JobExecutionOptions?

ExecutionSequence 

public int ExecutionSequence { get; }

Property Value

int

FailTaskIfJobFails 

public bool FailTaskIfJobFails { get; set; }

Property Value

bool

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.

JobVariables

The job variables defined for the object

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

Remarks

This collection only contains the variables defined explicitly for the object. Use GetInheritedVariables(bool) to retrieve variables inherited from higher levels.

To override a variable set at a higher level, add a new variable to this collection with the same name and the desired value.

MaxRunTime 

public int? MaxRunTime { get; set; }

Property Value

int?

RestartDelay 

public int? RestartDelay { get; set; }

Property Value

int?

RetryLimit 

public int? RetryLimit { get; set; }

Property Value

int?

SkipIfAlreadyRunning 

public bool? SkipIfAlreadyRunning { get; set; }

Property Value

bool?

SuccessRuleScriptOID 

public Guid? SuccessRuleScriptOID { get; set; }

Property Value

Guid?

TargetComputer 

public string TargetComputer { get; set; }

Property Value

string

TargetJob

The job the task 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 

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

TargetServerID 

public Guid? TargetServerID { get; set; }

Property Value

Guid?

Task 

public JobExecutionTask Task { get; }

Property Value

JobExecutionTask

WaitForJob 

public bool WaitForJob { get; set; }

Property Value

bool

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.

GetInheritedVariables(bool)

Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

If true the returned collection contains both inherited variables and variables defined at this level. If false the results only include inherited variables.

Returns

JobVariableCollection

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