Table of Contents

Class LogQueryParameters

Namespace
ArcanaDevelopment.adTempus.Shared
Assembly
ArcanaDevelopment.adTempus.Shared.dll

Parameters used when querying for log messages

[DataContract]
public class LogQueryParameters : HistoryQueryParameters
Inheritance
object
LogQueryParameters

Constructors

LogQueryParameters() 

public LogQueryParameters()

LogQueryParameters(LogQueryParameters) 

public LogQueryParameters(LogQueryParameters source)

Parameters

NameTypeDescription
source LogQueryParameters

Fields

GetAlerts

Determines whether messages flagged as alerts are retrieved.

[DataMember]
public IncludeExcludeType GetAlerts

Field Value

IncludeExcludeType

If set to Include, gets only alerts. If set to Exclude, gets only non-Alerts. If set to Unspecified, Alert status is ignored.

MessageAcknowledged

Determines whether acknowledged messages are returned.

[DataMember]
public IncludeExcludeType MessageAcknowledged

Field Value

IncludeExcludeType

Remarks

If Include, only gets messages that have been acknowledged. If Exclude, only gets messages that have not been acknowledged. If Unspecified, acknowledged status is ignored.

MessageSources

Only fetch messages with the specified source(s)

[DataMember]
public LogQueryParameters.MessageSource MessageSources

Field Value

LogQueryParameters.MessageSource

Properties

ExecutionHistoryItems

Only fetch messages associated with the specified job instance(s)

[DataMember]
public List<OID> ExecutionHistoryItems { get; protected set; }

Property Value

List<OID>

MessageClasses

Only fetch messages with the specified message class(es)

[DataMember]
public List<int> MessageClasses { get; protected set; }

Property Value

List<int>

MessageCodes

Only fetch messages with the specified message code(s)

[DataMember]
public List<string> MessageCodes { get; protected set; }

Property Value

List<string>

MessageIDs

Only fetch messages with the specified message ID(s)

[DataMember]
public List<int> MessageIDs { get; protected set; }

Property Value

List<int>

MessageTypes

Only fetch messages with the specified message type(S)

[DataMember]
public List<MessageType> MessageTypes { get; protected set; }

Property Value

List<MessageType>

SortOrder

The sort order to use when fetching records

[DataMember]
public List<LogQueryParameters.LogMessageSortOrder> SortOrder { get; protected set; }

Property Value

List<LogQueryParameters.LogMessageSortOrder>

Remarks

Specify any number of the LogQueryParameters.LogMessageSortOrder values. Records will be sorted by each specified option in sequence.

Inherited Members