com.solidfire.element.api

Class ScheduleObject

java.lang.Object

com.solidfire.element.api.ScheduleObject

All Implemented Interfaces:

java.io.Serializable

public class ScheduleObject
extends java.lang.Object
implements java.io.Serializable

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleObject.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ScheduleObject()
ScheduleObject(java.lang.String scheduleName, Optional<java.lang.Long[]> monthdays, Optional<DayOfWeek[]> weekdays, java.lang.Long hours, java.lang.Long minutes, java.lang.String scheduleType, Attributes attributes, Optional<java.lang.Boolean> hasError, Optional<java.lang.String> lastRunStatus, Optional<java.lang.String> lastRunTimeStarted, Optional<java.lang.Boolean> paused, Optional<java.lang.Boolean> recurring, Optional<java.lang.Boolean> runNextInterval, Optional<java.lang.Long> scheduleID, ScheduleInfoObject scheduleInfo, Optional<java.lang.String> startingDate, Optional<java.lang.Boolean> toBeDeleted)
ScheduleObject(java.lang.String scheduleName, Optional<java.lang.Long[]> monthdays, Optional<DayOfWeek[]> weekdays, java.lang.Long hours, java.lang.Long minutes, java.lang.String scheduleType, Attributes attributes, Optional<java.lang.Boolean> hasError, Optional<java.lang.String> lastRunStatus, Optional<java.lang.String> lastRunTimeStarted, Optional<java.lang.Boolean> paused, Optional<java.lang.Boolean> recurring, Optional<java.lang.Boolean> runNextInterval, Optional<java.lang.Long> scheduleID, ScheduleInfoObject scheduleInfo, Optional<java.lang.String> startingDate, Optional<java.lang.Boolean> toBeDeleted, Optional<java.lang.String> snapMirrorLabel)

Method Summary

Modifier and Type	Method and Description
ScheduleObject.Builder	asBuilder()
static ScheduleObject.Builder	builder()
boolean	equals(java.lang.Object o)
Attributes	getAttributes()
Optional<java.lang.Boolean>	getHasError() Indicates whether or not the schedule has errors.
java.lang.Long	getHours()
Optional<java.lang.String>	getLastRunStatus() Indicates the status of the last scheduled snapshot.
Optional<java.lang.String>	getLastRunTimeStarted() Indicates the last time the schedule started n ISO 8601 date string.
java.lang.Long	getMinutes()
Optional<java.lang.Long[]>	getMonthdays()
Optional<java.lang.Boolean>	getPaused() Indicates whether or not the schedule is paused.
Optional<java.lang.Boolean>	getRecurring() Indicates whether or not the schedule is recurring.
Optional<java.lang.Boolean>	getRunNextInterval() Indicates whether or not the schedule will run the next time the scheduler is active.
Optional<java.lang.Long>	getScheduleID() Unique ID of the schedule
ScheduleInfoObject	getScheduleInfo() 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.
java.lang.String	getScheduleName()
java.lang.String	getScheduleType()
Optional<java.lang.String>	getSnapMirrorLabel() The snapMirrorLabel to be applied to the created Snapshot or Group Snapshot, contained in the scheduleInfo.
Optional<java.lang.String>	getStartingDate() Indicates the date the first time the schedule began of will begin.
Optional<java.lang.Boolean>	getToBeDeleted() Indicates if the schedule is marked for deletion.
Optional<DayOfWeek[]>	getWeekdays()
int	hashCode()
void	setAttributes(Attributes attributes)
void	setHasError(Optional<java.lang.Boolean> hasError)
void	setHours(java.lang.Long hours)
void	setLastRunStatus(Optional<java.lang.String> lastRunStatus)
void	setLastRunTimeStarted(Optional<java.lang.String> lastRunTimeStarted)
void	setMinutes(java.lang.Long minutes)
void	setMonthdays(Optional<java.lang.Long[]> monthdays)
void	setPaused(Optional<java.lang.Boolean> paused)
void	setRecurring(Optional<java.lang.Boolean> recurring)
void	setRunNextInterval(Optional<java.lang.Boolean> runNextInterval)
void	setScheduleID(Optional<java.lang.Long> scheduleID)
void	setScheduleInfo(ScheduleInfoObject scheduleInfo)
void	setScheduleName(java.lang.String scheduleName)
void	setScheduleType(java.lang.String scheduleType)
void	setSnapMirrorLabel(Optional<java.lang.String> snapMirrorLabel)
void	setStartingDate(Optional<java.lang.String> startingDate)
void	setToBeDeleted(Optional<java.lang.Boolean> toBeDeleted)
void	setWeekdays(Optional<DayOfWeek[]> weekdays)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ScheduleObject

@Since(value="7.0")
public ScheduleObject()

ScheduleObject

@Since(value="7.0")
public ScheduleObject(java.lang.String scheduleName,
                                          Optional<java.lang.Long[]> monthdays,
                                          Optional<DayOfWeek[]> weekdays,
                                          java.lang.Long hours,
                                          java.lang.Long minutes,
                                          java.lang.String scheduleType,
                                          Attributes attributes,
                                          Optional<java.lang.Boolean> hasError,
                                          Optional<java.lang.String> lastRunStatus,
                                          Optional<java.lang.String> lastRunTimeStarted,
                                          Optional<java.lang.Boolean> paused,
                                          Optional<java.lang.Boolean> recurring,
                                          Optional<java.lang.Boolean> runNextInterval,
                                          Optional<java.lang.Long> scheduleID,
                                          ScheduleInfoObject scheduleInfo,
                                          Optional<java.lang.String> startingDate,
                                          Optional<java.lang.Boolean> toBeDeleted)

ScheduleObject

@Since(value="10.0")
public ScheduleObject(java.lang.String scheduleName,
                                           Optional<java.lang.Long[]> monthdays,
                                           Optional<DayOfWeek[]> weekdays,
                                           java.lang.Long hours,
                                           java.lang.Long minutes,
                                           java.lang.String scheduleType,
                                           Attributes attributes,
                                           Optional<java.lang.Boolean> hasError,
                                           Optional<java.lang.String> lastRunStatus,
                                           Optional<java.lang.String> lastRunTimeStarted,
                                           Optional<java.lang.Boolean> paused,
                                           Optional<java.lang.Boolean> recurring,
                                           Optional<java.lang.Boolean> runNextInterval,
                                           Optional<java.lang.Long> scheduleID,
                                           ScheduleInfoObject scheduleInfo,
                                           Optional<java.lang.String> startingDate,
                                           Optional<java.lang.Boolean> toBeDeleted,
                                           Optional<java.lang.String> snapMirrorLabel)

Method Detail

getScheduleName

public java.lang.String getScheduleName()

setScheduleName

public void setScheduleName(java.lang.String scheduleName)

getMonthdays

public Optional<java.lang.Long[]> getMonthdays()

setMonthdays

public void setMonthdays(Optional<java.lang.Long[]> monthdays)

getWeekdays

public Optional<DayOfWeek[]> getWeekdays()

setWeekdays

public void setWeekdays(Optional<DayOfWeek[]> weekdays)

getHours

public java.lang.Long getHours()

setHours

public void setHours(java.lang.Long hours)

getMinutes

public java.lang.Long getMinutes()

setMinutes

public void setMinutes(java.lang.Long minutes)

getScheduleType

public java.lang.String getScheduleType()

setScheduleType

public void setScheduleType(java.lang.String scheduleType)

getAttributes

public Attributes getAttributes()

setAttributes

public void setAttributes(Attributes attributes)

getHasError

public Optional<java.lang.Boolean> getHasError()

Indicates whether or not the schedule has errors.

setHasError

public void setHasError(Optional<java.lang.Boolean> hasError)

getLastRunStatus

public Optional<java.lang.String> getLastRunStatus()

Indicates the status of the last scheduled snapshot. Valid values are: Success Failed

setLastRunStatus

public void setLastRunStatus(Optional<java.lang.String> lastRunStatus)

getLastRunTimeStarted

public Optional<java.lang.String> getLastRunTimeStarted()

Indicates the last time the schedule started n ISO 8601 date string. Valid values are: Success Failed

setLastRunTimeStarted

public void setLastRunTimeStarted(Optional<java.lang.String> lastRunTimeStarted)

getPaused

public Optional<java.lang.Boolean> getPaused()

Indicates whether or not the schedule is paused.

setPaused

public void setPaused(Optional<java.lang.Boolean> paused)

getRecurring

public Optional<java.lang.Boolean> getRecurring()

Indicates whether or not the schedule is recurring.

setRecurring

public void setRecurring(Optional<java.lang.Boolean> recurring)

getRunNextInterval

public Optional<java.lang.Boolean> getRunNextInterval()

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".

setRunNextInterval

public void setRunNextInterval(Optional<java.lang.Boolean> runNextInterval)

getScheduleID

public Optional<java.lang.Long> getScheduleID()

Unique ID of the schedule

setScheduleID

public void setScheduleID(Optional<java.lang.Long> scheduleID)

getScheduleInfo

public ScheduleInfoObject getScheduleInfo()

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.

setScheduleInfo

public void setScheduleInfo(ScheduleInfoObject scheduleInfo)

getStartingDate

public Optional<java.lang.String> getStartingDate()

Indicates the date the first time the schedule began of will begin. Formatted in UTC time.

setStartingDate

public void setStartingDate(Optional<java.lang.String> startingDate)

getToBeDeleted

public Optional<java.lang.Boolean> getToBeDeleted()

Indicates if the schedule is marked for deletion.

setToBeDeleted

public void setToBeDeleted(Optional<java.lang.Boolean> toBeDeleted)

getSnapMirrorLabel

public Optional<java.lang.String> getSnapMirrorLabel()

The snapMirrorLabel to be applied to the created Snapshot or Group Snapshot, contained in the scheduleInfo.

setSnapMirrorLabel

public void setSnapMirrorLabel(Optional<java.lang.String> snapMirrorLabel)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ScheduleObject.Builder builder()

asBuilder

public final ScheduleObject.Builder asBuilder()