Click or drag to resize

ScheduleObject Class

ScheduleObject ScheduleObject 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 Hierarchy
SystemObject
  SolidFire.CoreRpcBase
    SolidFire.Element.ApiScheduleObject

Namespace:  SolidFire.Element.Api
Assembly:  SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
Syntax
C#
public class ScheduleObject : RpcBase

The ScheduleObject type exposes the following members.

Constructors
  NameDescription
Public methodScheduleObject
Initializes a new instance of the ScheduleObject class
Top
Properties
  NameDescription
Public propertyAttributes
Public propertyHasError
Indicates whether or not the schedule has errors.
Public propertyHours
Public propertyLastRunStatus
Indicates the status of the last scheduled snapshot. Valid values are: Success Failed
Public propertyLastRunTimeStarted
Indicates the last time the schedule started n ISO 8601 date string. Valid values are: Success Failed
Public propertyMinutes
Public propertyMonthdays
Public propertyPaused
Indicates whether or not the schedule is paused.
Public propertyRecurring
Indicates whether or not the schedule is recurring.
Public propertyRunNextInterval
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".
Public propertyScheduleID
Unique ID of the schedule
Public propertyScheduleInfo
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.
Public propertyScheduleName
Public propertyScheduleType
Public propertySnapMirrorLabel
The snapMirrorLabel to be applied to the created Snapshot or Group Snapshot, contained in the scheduleInfo.
Public propertyStartingDate
Indicates the date the first time the schedule began of will begin. Formatted in UTC time.
Public propertyToBeDeleted
Indicates if the schedule is marked for deletion.
Public propertyWeekdays
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.)
Top
See Also