Class ExceptionEventSearch

Namespace

Geotab.Checkmate.ObjectModel.Exceptions

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for ExceptionEvent.

This search has been designed to work efficiently with these combinations of parameters:

public class ExceptionEventSearch : Search, IEntity

Inheritance

object

Search

ExceptionEventSearch

Implements

IEntity

Inherited Members

Search.Clone()

Search.GetReadOnly()

Search.Id

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ExceptionEventSearch()

Initializes a new instance of the ExceptionEventSearch class.Constructor.

public ExceptionEventSearch()

ExceptionEventSearch(Id?)

Initializes a new instance of the ExceptionEventSearch class.Constructor.

public ExceptionEventSearch(Id? id)

Parameters

id Id

The Id.

Properties

DeviceSearch

Gets or sets filter by the DeviceSearch options. Providing a Device ID will search for any Exception Events recorded for that Device. Providing Groups will search Exception Events recorded for Devices that are members of the provided GroupSearch(s) or their children. Available DeviceSearch options are:.

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

FromDate

Gets or sets search for Exception Events that occurred at this date or after.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

IncludeDeleted

Gets or sets search for ExceptionEvents that have been soft deleted for any reason.

public bool? IncludeDeleted { get; set; }

Property Value

bool?

bool

IncludeDismissedEvents

Gets or sets include dismissed events.

public bool? IncludeDismissedEvents { get; set; }

Property Value

bool?

bool

IncludeInvalidated

Gets or sets search for ExceptionEvents that have been invalidated because of new data being processed. The default value is [false] while using "Get" and "GetFeed" APIs.

public bool? IncludeInvalidated { get; set; }

Property Value

bool?

bool

IncludeMetadata

Gets or sets the flag to include metadata.

public bool? IncludeMetadata { get; set; }

Property Value

bool?

bool

MaxVersion

Gets or sets the maximum row version of the ExceptionEvent search criteria.

public long? MaxVersion { get; set; }

Property Value

long?

long

RuleSearch

Gets or sets filter by the RuleSearch options. Providing a Rule ID will search for any Exception Events recorded for that Rule. Providing a ExceptionRuleBaseType will search for any Exception Events with the given Base Type. Available RuleSearch options are:.

public RuleSearch? RuleSearch { get; set; }

Property Value

RuleSearch

RuleSearch

ToDate

Gets or sets search for Exception Events that occurred at this date or before.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

UserSearch

Gets or sets the filter by the UserSearch options. Providing a User ID will search for any Exception Events recorded for that User. Providing Groups will search Exception Events recorded for Users that are members of the provided GroupSearch(s) or their children. Available UserSearch options are:

Cannot be used with DeviceSearch.

public UserSearch? UserSearch { get; set; }

Property Value

UserSearch

UserSearch

Version

Gets or sets the row version of the ExceptionEvent search criteria.

public override long? Version { get; set; }

Property Value

long?

long

ZoneSearch

Gets or sets filter by the ZoneSearch options. Providing a zone ID will search for Exception Events recorded with ZoneId metadata. Providing the Groups will search for Exception Events recorded with ZoneId metadata of Zones that are members of the provided GroupSearch(s) or their children. Available ZoneSearch options are:.

public ZoneSearch? ZoneSearch { get; set; }

Property Value

ZoneSearch

ZoneSearch