com.solidfire.element.apiactual

Class ApiCreateScheduleRequest

Object

ApiCreateScheduleRequest

All Implemented Interfaces:

Serializable

public class ApiCreateScheduleRequest
extends Object
implements Serializable

The Request object for the "CreateSchedule" API Service call.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiCreateScheduleRequest.Builder

Constructor Summary

Constructors

Constructor and Description
ApiCreateScheduleRequest(Map<String,Object> attributes, Optional<Long> hours, Optional<Long> minutes, Optional<Boolean> paused, Optional<Boolean> recurring, String scheduleName, String scheduleType, ApiScheduleInfo scheduleInfo, Optional<String> startingDate, Optional<Long[]> monthdays, Optional<ApiWeekday[]> weekdays) The Request object for the "CreateSchedule" API Service call.

Method Summary

Methods

Modifier and Type	Method and Description
ApiCreateScheduleRequest.Builder	asBuilder()
static ApiCreateScheduleRequest.Builder	builder()
boolean	equals(Object o)
Map<String,Object>	getAttributes() The "frequency" object is returned in "attributes" to indicate the frequency at which the snapshot will be made. Valid values for "frequency" are: Days of Week Days of Month Time Interval
Optional<Long>	getHours() Number of hours between snapshots or hour at which the snapshot will occur in "Days of Week", or "Days of Month" mode. Valid values: 0 - 24
Optional<Long>	getMinutes() Number of minutes between snapshots or minute at which the snapshot will occur in "Days of Week", or "Days of Month" mode. Valid values: 0 - 59
Optional<Long[]>	getMonthdays() The days of the month that a snapshot will be made.
Optional<Boolean>	getPaused() Indicates if the schedule should be paused or not.
Optional<Boolean>	getRecurring() Indicates if the schedule will be recurring or not.
ApiScheduleInfo	getScheduleInfo() An object of schedule information about how the snapshot should be created at each scheduled interval. volumeID - The ID of the volume to be included in the snapshot.
String	getScheduleName() Unique name for the schedule.
String	getScheduleType() Indicates the type of schedule to create. Valid value is: snapshot
Optional<String>	getStartingDate() Time after which the schedule will be run.
Optional<ApiWeekday[]>	getWeekdays() Day of the week the snapshot is to be created.
int	hashCode()
String	toString()

Methods inherited from class Object

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

Constructor Detail

ApiCreateScheduleRequest

@Since(value="8.0")
public ApiCreateScheduleRequest(Map<String,Object> attributes,
                                   Optional<Long> hours,
                                   Optional<Long> minutes,
                                   Optional<Boolean> paused,
                                   Optional<Boolean> recurring,
                                   String scheduleName,
                                   String scheduleType,
                                   ApiScheduleInfo scheduleInfo,
                                   Optional<String> startingDate,
                                   Optional<Long[]> monthdays,
                                   Optional<ApiWeekday[]> weekdays)

The Request object for the "CreateSchedule" API Service call.

Parameters:

attributes - [required] The "frequency" object is returned in "attributes" to indicate the frequency at which the snapshot will be made.

hours - (optional) Number of hours between snapshots or hour at which the snapshot will occur in "Days of Week", or "Days of Month" mode.

minutes - (optional) Number of minutes between snapshots or minute at which the snapshot will occur in "Days of Week", or "Days of Month" mode.

paused - (optional) Indicates if the schedule should be paused or not.

recurring - (optional) Indicates if the schedule will be recurring or not.

scheduleName - [required] Unique name for the schedule.

scheduleType - [required] Indicates the type of schedule to create.

scheduleInfo - [required] An object of schedule information about how the snapshot should be created at each scheduled interval.

startingDate - (optional) Time after which the schedule will be run. If not set the schedule starts immediately. Formatted in UTC time.

monthdays - (optional) The days of the month that a snapshot will be made.

weekdays - (optional) Day of the week the snapshot is to be created.

Since:

8.0

Method Detail

getAttributes

public Map<String,Object> getAttributes()

The "frequency" object is returned in "attributes" to indicate the frequency at which the snapshot will be made.
Valid values for "frequency" are:
Days of Week
Days of Month
Time Interval

getHours

public Optional<Long> getHours()

Number of hours between snapshots or hour at which the snapshot will occur in "Days of Week", or "Days of Month" mode.
Valid values: 0 - 24

getMinutes

public Optional<Long> getMinutes()

Number of minutes between snapshots or minute at which the snapshot will occur in "Days of Week", or "Days of Month" mode.
Valid values: 0 - 59

getPaused

public Optional<Boolean> getPaused()

Indicates if the schedule should be paused or not.

getRecurring

public Optional<Boolean> getRecurring()

Indicates if the schedule will be recurring or not.

getScheduleName

public String getScheduleName()

Unique name for the schedule.

getScheduleType

public String getScheduleType()

Indicates the type of schedule to create.
Valid value is:
snapshot

getScheduleInfo

public ApiScheduleInfo getScheduleInfo()

An object of schedule information about how the snapshot should be created at each scheduled interval.
volumeID - The ID of the volume to be included in the snapshot. (Integer)
volumes - A list of volume IDs to be included in the group snapshot. (Array of Integers)
name - The snapshot name to be used. (String)
enableRemoteReplication - Indicates if the snapshot should be included in remote replication. (Boolean)
retention - The amount of time the snapshot will be retained in HH:mm:ss. (String)

getStartingDate

public Optional<String> getStartingDate()

Time after which the schedule will be run. If not set the schedule starts immediately. Formatted in UTC time.

getMonthdays

public Optional<Long[]> getMonthdays()

The days of the month that a snapshot will be made.
Valid values: 1 - 31

getWeekdays

public Optional<ApiWeekday[]> getWeekdays()

Day of the week the snapshot is to be created.
Required values:
day: 0 - 6 (Sunday - Saturday)
offset: 1

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static ApiCreateScheduleRequest.Builder builder()

asBuilder

public final ApiCreateScheduleRequest.Builder asBuilder()