com.solidfire.element.api

Class Schedule

Object

Schedule

All Implemented Interfaces:

Serializable

public class Schedule
extends Object
implements Serializable

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 page 245.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schedule.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Schedule()
Schedule(Frequency frequency, Optional<Boolean> hasError, String lastRunStatus, String lastRunTimeStarted, Optional<Boolean> paused, Optional<Boolean> recurring, Optional<Boolean> runNextInterval, Optional<Long> scheduleID, ScheduleInfo scheduleInfo, String name, String startingDate, Optional<Boolean> toBeDeleted)

Method Summary

Methods

Modifier and Type	Method and Description
Schedule.Builder	asBuilder()
static Schedule.Builder	builder()
boolean	equals(Object o)
Frequency	getFrequency() Indicates the frequency of the schedule occurrence.
Optional<Boolean>	getHasError() Indicates whether or not the schedule has errors.
String	getLastRunStatus() Indicates the status of the last scheduled snapshot.
String	getLastRunTimeStarted() Indicates the last time the schedule started n ISO 8601 date string.
String	getName() Unique name assigned to the schedule.
Optional<Boolean>	getPaused() Indicates whether or not the schedule is paused.
Optional<Boolean>	getRecurring() Indicates whether or not the schedule is recurring.
Optional<Boolean>	getRunNextInterval() Indicates whether or not the schedule will run the next time the scheduler is active.
Optional<Long>	getScheduleID() Unique ID of the schedule
ScheduleInfo	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.
String	getStartingDate() Indicates the date the first time the schedule began of will begin.
Optional<Boolean>	getToBeDeleted() Indicates if the schedule is marked for deletion.
int	hashCode()
void	setFrequency(Frequency frequency)
void	setHasError(Optional<Boolean> hasError)
void	setLastRunStatus(String lastRunStatus)
void	setLastRunTimeStarted(String lastRunTimeStarted)
void	setName(String name)
void	setPaused(Optional<Boolean> paused)
void	setRecurring(Optional<Boolean> recurring)
void	setRunNextInterval(Optional<Boolean> runNextInterval)
void	setScheduleID(Optional<Long> scheduleID)
void	setScheduleInfo(ScheduleInfo scheduleInfo)
void	setStartingDate(String startingDate)
void	setToBeDeleted(Optional<Boolean> toBeDeleted)
Map<String,Object>	toMap()
String	toString()

Methods inherited from class Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Schedule

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

Schedule

@Since(value="7.0")
public Schedule(Frequency frequency,
                   Optional<Boolean> hasError,
                   String lastRunStatus,
                   String lastRunTimeStarted,
                   Optional<Boolean> paused,
                   Optional<Boolean> recurring,
                   Optional<Boolean> runNextInterval,
                   Optional<Long> scheduleID,
                   ScheduleInfo scheduleInfo,
                   String name,
                   String startingDate,
                   Optional<Boolean> toBeDeleted)

Method Detail

getFrequency

public Frequency getFrequency()

Indicates the frequency of the schedule occurrence. Set this to a type that inherits from Frequency. Valid types are: DayOfWeekFrequency DayOfMonthFrequency TimeIntervalFrequency

setFrequency

public void setFrequency(Frequency frequency)

getHasError

public Optional<Boolean> getHasError()

Indicates whether or not the schedule has errors.

setHasError

public void setHasError(Optional<Boolean> hasError)

getLastRunStatus

public String getLastRunStatus()

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

setLastRunStatus

public void setLastRunStatus(String lastRunStatus)

getLastRunTimeStarted

public String getLastRunTimeStarted()

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

setLastRunTimeStarted

public void setLastRunTimeStarted(String lastRunTimeStarted)

getPaused

public Optional<Boolean> getPaused()

Indicates whether or not the schedule is paused.

setPaused

public void setPaused(Optional<Boolean> paused)

getRecurring

public Optional<Boolean> getRecurring()

Indicates whether or not the schedule is recurring.

setRecurring

public void setRecurring(Optional<Boolean> recurring)

getRunNextInterval

public Optional<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<Boolean> runNextInterval)

getScheduleID

public Optional<Long> getScheduleID()

Unique ID of the schedule

setScheduleID

public void setScheduleID(Optional<Long> scheduleID)

getScheduleInfo

public ScheduleInfo 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(ScheduleInfo scheduleInfo)

getName

public String getName()

Unique name assigned to the schedule.

setName

public void setName(String name)

getStartingDate

public String getStartingDate()

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

setStartingDate

public void setStartingDate(String startingDate)

getToBeDeleted

public Optional<Boolean> getToBeDeleted()

Indicates if the schedule is marked for deletion.

setToBeDeleted

public void setToBeDeleted(Optional<Boolean> toBeDeleted)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toMap

public Map<String,Object> toMap()

toString

public String toString()

Overrides:

toString in class Object

builder

public static Schedule.Builder builder()

asBuilder

public final Schedule.Builder asBuilder()