Table of Contents

Class LogMessage

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class LogMessage : ADTObject
Inheritance
object
LogMessage

Properties

Acknowledged

public bool Acknowledged { get; }

Property Value

bool

AdditionalData

public string AdditionalData { get; }

Property Value

string

AgentOID

public OID AgentOID { get; }

Property Value

OID

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

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.

ComputerName

public string ComputerName { get; }

Property Value

string

ComputerNameOrAgentName

public string ComputerNameOrAgentName { get; }

Property Value

string

ExecutionHistoryOID

public OID ExecutionHistoryOID { get; }

Property Value

OID

ExecutionHistoryStepOID

public OID ExecutionHistoryStepOID { get; }

Property Value

OID

InstanceID

public int InstanceID { get; }

Property Value

int

IsAlert

public bool IsAlert { get; }

Property Value

bool

IsDependent

public override bool IsDependent { get; }

Property Value

bool

Job

The Job to which this item belongs.

public Job Job { get; }

Property Value

Job

Remarks

The Job may be null if the message is not associated with a particular job or if the job has been deleted from the server (execution history may not be deleted at the same time the job is deleted).

JobGroupName

public string JobGroupName { get; }

Property Value

string

JobGroupOID

public OID JobGroupOID { get; }

Property Value

OID

JobName

public string JobName { get; }

Property Value

string

JobOID

public OID JobOID { get; }

Property Value

OID

JobQueueName

public string JobQueueName { get; }

Property Value

string

JobQueueOID

public OID JobQueueOID { get; }

Property Value

OID

Message

public string Message { get; }

Property Value

string

MessageClass

public int MessageClass { get; }

Property Value

int

MessageCode

public string MessageCode { get; }

Property Value

string

MessageID

public int MessageID { get; }

Property Value

int

MessageTimestamp

[ComVisible(false)]
public DateTimeOffset MessageTimestamp { get; }

Property Value

DateTimeOffset

MessageType

public MessageType MessageType { get; }

Property Value

MessageType

MessageTypeDescription

Gets the text description of the MessageType

public string MessageTypeDescription { get; }

Property Value

string

RecordID

public int RecordID { get; }

Property Value

int

RemoteAgent

public RemoteAgent RemoteAgent { get; }

Property Value

RemoteAgent

Source

public string Source { get; }

Property Value

string

StepNumber

public int StepNumber { get; }

Property Value

int

StepOID

public OID StepOID { get; }

Property Value

OID

UpdateMessageID

public string UpdateMessageID { get; }

Property Value

string

UserID

public string UserID { get; }

Property Value

string

Methods

Acknowledge(int)

public void Acknowledge(int options)

Parameters

NameTypeDescription
options int

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.

See Also

Refresh()

Reverts the object (and any contained objects) to their last-saved state, discarding any in-memory changes.

public void Refresh()

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members