com.solidfire.element.apiactual

Class ApiSchedule

java.lang.Object

com.solidfire.element.apiactual.ApiSchedule

All Implemented Interfaces:

java.io.Serializable

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

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	ApiSchedule.Builder

Constructor Summary

Constructors

Constructor and Description

ApiSchedule(java.util.Map<java.lang.String,java.lang.Object> attributes, java.lang.Boolean hasError, java.lang.Long hours, java.lang.String lastRunStatus, java.lang.String lastRunTimeStarted, java.lang.Long minutes, java.lang.Long[] monthdays, java.lang.Boolean paused, java.lang.Boolean recurring, java.lang.Boolean runNextInterval, java.lang.Long scheduleID, ApiScheduleInfo scheduleInfo, java.lang.String scheduleName, java.lang.String scheduleType, java.lang.String startingDate, java.lang.Boolean toBeDeleted, ApiWeekday[] weekdays) Schedule is an object containing information about each schedule created to autonomously make a snapshot of a volume.

Method Summary

Modifier and Type	Method and Description
ApiSchedule.Builder	asBuilder()
static ApiSchedule.Builder	builder()
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Indicates the frequency of the schedule occurrence. Valid values are: Day of Week Day of Month Time Interval
java.lang.Boolean	getHasError() Indicates whether or not the schedule has errors.
java.lang.Long	getHours() Shows the hours that will elapse before the next snapshot is created. Valid values are: 0 - 24
java.lang.String	getLastRunStatus() Indicates the status of the last scheduled snapshot. Valid values are: Success Failed
java.lang.String	getLastRunTimeStarted() Indicates the last time the schedule started n ISO 8601 date string.
java.lang.Long	getMinutes() Shows the minutes that will elapse before the next snapshot is created.
java.lang.Long[]	getMonthdays() Shows the days of the month that the next snapshot will be created on.
java.lang.Boolean	getPaused() Indicates whether or not the schedule is paused.
java.lang.Boolean	getRecurring() Indicates whether or not the schedule is recurring.
java.lang.Boolean	getRunNextInterval() Indicates whether or not the schedule will run the next time the scheduler is active.
java.lang.Long	getScheduleID() Unique ID of the schedule
ApiScheduleInfo	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() Unique name assigned to the schedule.
java.lang.String	getScheduleType() Only "snapshot" is supported at this time.
java.lang.String	getStartingDate() Indicates the date the first time the schedule began of will begin.
java.lang.Boolean	getToBeDeleted() Indicates if the schedule is marked for deletion.
ApiWeekday[]	getWeekdays() Indicates the days of the week that a snapshot will be made.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiSchedule

@Since(value="7.0")
public ApiSchedule(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                       java.lang.Boolean hasError,
                                       java.lang.Long hours,
                                       java.lang.String lastRunStatus,
                                       java.lang.String lastRunTimeStarted,
                                       java.lang.Long minutes,
                                       java.lang.Long[] monthdays,
                                       java.lang.Boolean paused,
                                       java.lang.Boolean recurring,
                                       java.lang.Boolean runNextInterval,
                                       java.lang.Long scheduleID,
                                       ApiScheduleInfo scheduleInfo,
                                       java.lang.String scheduleName,
                                       java.lang.String scheduleType,
                                       java.lang.String startingDate,
                                       java.lang.Boolean toBeDeleted,
                                       ApiWeekday[] weekdays)

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.

Parameters:

attributes - [required] Indicates the frequency of the schedule occurrence.

hasError - [required] Indicates whether or not the schedule has errors.

hours - [required] Shows the hours that will elapse before the next snapshot is created.

lastRunStatus - [required] Indicates the status of the last scheduled snapshot.

lastRunTimeStarted - [required] Indicates the last time the schedule started n ISO 8601 date string.

minutes - [required] Shows the minutes that will elapse before the next snapshot is created.

monthdays - [required] Shows the days of the month that the next snapshot will be created on.

paused - [required] Indicates whether or not the schedule is paused.

recurring - [required] Indicates whether or not the schedule is recurring.

runNextInterval - [required] 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 - [required] Unique ID of the schedule

scheduleInfo - [required] 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 - [required] Unique name assigned to the schedule.

scheduleType - [required] Only "snapshot" is supported at this time.

startingDate - [required] Indicates the date the first time the schedule began of will begin. Formatted in UTC time.

toBeDeleted - [required] Indicates if the schedule is marked for deletion.

weekdays - [required] Indicates the days of the week that a snapshot will be made.

Since:

7.0

Method Detail

getAttributes

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

Indicates the frequency of the schedule occurrence.
Valid values are:
Day of Week
Day of Month
Time Interval

getHasError

public java.lang.Boolean getHasError()

Indicates whether or not the schedule has errors.

getHours

public java.lang.Long getHours()

Shows the hours that will elapse before the next snapshot is created.
Valid values are: 0 - 24

getLastRunStatus

public java.lang.String getLastRunStatus()

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

getLastRunTimeStarted

public java.lang.String getLastRunTimeStarted()

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

getMinutes

public java.lang.Long getMinutes()

Shows the minutes that will elapse before the next snapshot is created. Valid values are: 0 - 59

getMonthdays

public java.lang.Long[] getMonthdays()

Shows the days of the month that the next snapshot will be created on. Valid values are: 0 - 31

getPaused

public java.lang.Boolean getPaused()

Indicates whether or not the schedule is paused.

getRecurring

public java.lang.Boolean getRecurring()

Indicates whether or not the schedule is recurring.

getRunNextInterval

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

getScheduleID

public java.lang.Long getScheduleID()

Unique ID of the schedule

getScheduleInfo

public ApiScheduleInfo 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.

getScheduleName

public java.lang.String getScheduleName()

Unique name assigned to the schedule.

getScheduleType

public java.lang.String getScheduleType()

Only "snapshot" is supported at this time.

getStartingDate

public java.lang.String getStartingDate()

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

getToBeDeleted

public java.lang.Boolean getToBeDeleted()

Indicates if the schedule is marked for deletion.

getWeekdays

public ApiWeekday[] getWeekdays()

Indicates the days of the week that a snapshot will be made.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ApiSchedule.Builder builder()

asBuilder

public final ApiSchedule.Builder asBuilder()