Schedule Class |
Schedule
Schedule is an object containing information about each schedule created to autonomously make a snapshot of a volume. The return object includes information for all schedules. If scheduleID is used to identify a specific schedule then only information for that scheduleID is returned. Schedules information is returned with the API method, see ListSchedules on the SolidFire API guide.
Inheritance HierarchyNamespace: SolidFire.Element.Api
Assembly: SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
SyntaxC#
public class Schedule : RpcBase
The Schedule type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Frequency |
Indicates the frequency of the schedule occurrence. Set this to a type that inherits from Frequency.
Valid types are:
DayOfWeekFrequency
DayOfMonthFrequency
TimeIntervalFrequency
|
| HasError |
Indicates whether or not the schedule has errors.
|
| LastRunStatus |
Indicates the status of the last scheduled snapshot.
Valid values are:
Success
Failed
|
| LastRunTimeStarted |
Indicates the last time the schedule started n ISO 8601 date string.
Valid values are:
Success
Failed
|
| Name |
Unique name assigned to the schedule.
|
| Paused |
Indicates whether or not the schedule is paused.
|
| Recurring |
Indicates whether or not the schedule is recurring.
|
| RunNextInterval |
Indicates whether or not the schedule will run the next time the scheduler is active. When set to "true", the schedule will run the next time the scheduler is active and then reset back to "false".
|
| ScheduleID |
Unique ID of the schedule
|
| ScheduleInfo |
Includes the unique name given to the schedule, the retention period for the snapshot that was created, and the volume ID of the volume from which the snapshot was created.
|
| StartingDate |
Indicates the date the first time the schedule began of will begin. Formatted in UTC time.
|
| ToBeDeleted |
Indicates if the schedule is marked for deletion.
|
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToApiSchedule | (Defined by ScheduleAdaptor.) |
See Also