ApiSchedule Class |
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 page 245.
Inheritance HierarchyNamespace: SolidFire.Element.Api
Assembly: SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
SyntaxC#
public class ApiSchedule : RpcBase
The ApiSchedule type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ApiSchedule | Initializes a new instance of the ApiSchedule class |
Properties| Name | Description | |
|---|---|---|
 | Attributes |
Indicates the frequency of the schedule occurrence. Valid values are: Day of Week Day of Month Time Interval |
| HasError |
Indicates whether or not the schedule has errors.
|
| Hours |
Shows the hours that will elapse before the next snapshot is created. Valid values are: 0 - 24 |
| 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 |
| Minutes |
Shows the minutes that will elapse before the next snapshot is created.
Valid values are: 0 - 59
|
| Monthdays |
Shows the days of the month that the next snapshot will be created on.
Valid values are: 0 - 31
|
| 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.
|
| ScheduleName |
Unique name assigned to the schedule.
|
| ScheduleType |
Only "snapshot" is supported at this time.
|
| 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.
|
| Weekdays |
Indicates the days of the week that a snapshot will be made.
|
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 | |
|---|---|---|
 | ToSchedule | (Defined by ScheduleAdaptor.) |
See Also