Class MaintenanceSchedule

Namespace

Geotab.Checkmate.Settings

Assembly

Geotab.Checkmate.ObjectModel.dll

The schedules for database maintenance events.

public class MaintenanceSchedule

Inheritance

object

MaintenanceSchedule

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

MaintenanceSchedule()

Initializes a new instance of the MaintenanceSchedule class.

public MaintenanceSchedule()

MaintenanceSchedule(MaintenanceSchedule)

Initializes a new instance of the MaintenanceSchedule class.

protected MaintenanceSchedule(MaintenanceSchedule schedule)

Parameters

schedule MaintenanceSchedule

The cloned MaintenanceSchedule instance.

Properties

AccessFolder

Gets or sets access folder of maintenance schedule.

public string AccessFolder { get; set; }

Property Value

string

Access folder of maintenance schedule.

AllowedUserInactivityPeriod

Gets or sets the allowed No access period for user in days.

public int? AllowedUserInactivityPeriod { get; set; }

Property Value

int?

The allowed No access period for user in days.

DvirPurgePeriodToKeep

Gets or sets the DVIR purge period to keep.

public DatabaseMaintenancePeriod DvirPurgePeriodToKeep { get; set; }

Property Value

DatabaseMaintenancePeriod

The DVIR purge period to keep.

EnablePurge

Gets or sets a value indicating whether to enable purge.

public bool EnablePurge { get; set; }

Property Value

bool

A value indicating whether to enable purge.

EndTime

Gets or sets the end time of the purge in seconds. Time of day is in UTC and is checked against the admin time. The default time is 5AM.

public TimeSpan EndTime { get; set; }

Property Value

TimeSpan

The end time of the purge in seconds. Time of day is in UTC and is checked against the admin time. The default time is 5AM.

FuelTransactionPeriodToKeep

Gets or sets the private trip purge period to keep.

public DatabaseMaintenancePeriod FuelTransactionPeriodToKeep { get; set; }

Property Value

DatabaseMaintenancePeriod

The private trip purge period to keep.

GroupId

Gets or sets the group affected by the purge schedule.

public string GroupId { get; set; }

Property Value

string

The group affected by the purge schedule.

HosPurgePeriodToKeep

Gets or sets the HOS purge period to keep.

public DatabaseMaintenancePeriod HosPurgePeriodToKeep { get; set; }

Property Value

DatabaseMaintenancePeriod

The HOS purge period to keep.

LastPurgeDate

Gets or sets the last purge date.

public DateTime LastPurgeDate { get; set; }

Property Value

DateTime

The last purge date.

MaintenancePeriod

Gets or sets how often the purge is run.

public DatabaseMaintenancePeriod MaintenancePeriod { get; set; }

Property Value

DatabaseMaintenancePeriod

How often the purge is run.

NumberOfThreads

Gets or sets the maximum number of threads the purge can use.

public int NumberOfThreads { get; set; }

Property Value

int

The maximum number of threads the purge can use.

PrivatePurgePeriodToKeep

Gets or sets the private trip purge period to keep.

public DatabaseMaintenancePeriod PrivatePurgePeriodToKeep { get; set; }

Property Value

DatabaseMaintenancePeriod

The private trip purge period to keep.

PurgePeriodToKeep

Gets or sets the purge period to keep.

public DatabaseMaintenancePeriod PurgePeriodToKeep { get; set; }

Property Value

DatabaseMaintenancePeriod

The purge period to keep.

RunUntilComplete

Gets or sets a value indicating whether the purge will run until it completes rather than ending when the EndTime is reached. StartTime it still used to indicate the time the purge will start.

public bool RunUntilComplete { get; set; }

Property Value

bool

A value indicating whether the purge will run until it completes rather than ending when the EndTime is reached. StartTime it still used to indicate the time the purge will start.

SettingsHash

Gets or sets this is used to determine if a change has been made to the settings during a backup/purge, so that we do not resume. This value should only be set in the backup/purge class, not when the settings are changed in the GUI. Do not include this value in GetHash().

public int? SettingsHash { get; set; }

Property Value

int?

This is used to determine if a change has been made to the settings during a backup/purge, so that we do not resume. This value should only be set in the backup/purge class, not when the settings are changed in the GUI. Do not include this value in GetHash().

SqlServerName

Gets or sets sql server name.

public string SqlServerName { get; set; }

Property Value

string

Sql server name.

StartTime

Gets or sets the start time of the purge in seconds. Time of day is in UTC and is checked against the admin time.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

The start time of the purge in seconds. Time of day is in UTC and is checked against the admin time.

Methods

Clone()

Creates a new object that is a copy of the current instance.

public object Clone()

Returns

object

A new object that is a copy of this instance.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object .

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as a hash function for a particular type. GetHashCode() is suitable for use in hashing algorithms and data structures like a hash table.

public override int GetHashCode()

Returns

int

A hash code for the current object.