com.solidfire.element.apiactual

Class ApiModifyScheduleRequest

java.lang.Object

com.solidfire.element.apiactual.ApiModifyScheduleRequest

All Implemented Interfaces:

java.io.Serializable

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiModifyScheduleRequest.Builder

Constructor Summary

Constructors

Constructor and Description

ApiModifyScheduleRequest(Optional<java.util.Map<java.lang.String,java.lang.Object>> attributes, Optional<java.lang.Long> hours, Optional<java.lang.Long> minutes, Optional<java.lang.Long[]> monthdays, Optional<java.lang.Boolean> paused, Optional<java.lang.Boolean> recurring, Optional<java.lang.Boolean> runNextInterval, java.lang.Long scheduleID, Optional<ApiScheduleInfo> scheduleInfo, Optional<java.lang.String> scheduleName, Optional<java.lang.String> scheduleType, Optional<java.lang.String> startingDate, Optional<java.lang.Boolean> toBeDeleted, Optional<ApiWeekday[]> weekdays) The Request object for the "ModifySchedule" API Service call.

Method Summary

Modifier and Type	Method and Description
ApiModifyScheduleRequest.Builder	asBuilder()
static ApiModifyScheduleRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.util.Map<java.lang.String,java.lang.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<java.lang.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<java.lang.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<java.lang.Long[]>	getMonthdays() The days of the month that a snapshot will be made.
Optional<java.lang.Boolean>	getPaused() Indicates if the schedule should be paused or not.
Optional<java.lang.Boolean>	getRecurring() Indicates if the schedule will be recurring or not.
Optional<java.lang.Boolean>	getRunNextInterval() Use to choose to run the schedule when the scheduler the next time the scheduler is active.
java.lang.Long	getScheduleID() Unique ID of the schedule.
Optional<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.
Optional<java.lang.String>	getScheduleName() Unique name for the schedule.
Optional<java.lang.String>	getScheduleType() Only "snapshot" is supported at this time.
Optional<java.lang.String>	getStartingDate() Indicates the date the first time the schedule began or will begin.
Optional<java.lang.Boolean>	getToBeDeleted() Indicates if the schedule is marked for deletion.
Optional<ApiWeekday[]>	getWeekdays() Day of the week the snapshot is to be created.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiModifyScheduleRequest

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

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

Parameters:

attributes - (optional) 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.

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

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

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

runNextInterval - (optional) Use to choose to run the schedule when the scheduler 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 - (optional) An object of schedule information about how the snapshot should be created at each scheduled interval.

scheduleName - (optional) Unique name for the schedule.

scheduleType - (optional) Only "snapshot" is supported at this time.

startingDate - (optional) Indicates the date the first time the schedule began or will begin.

toBeDeleted - (optional) Indicates if the schedule is marked for deletion.

weekdays - (optional) Day of the week the snapshot is to be created. The day of the week starts at Sunday with the value of "0" and an offset of "1." Monday has a value of "1" with an offset of "1", etc.

Since:

8.0

Method Detail

getAttributes

public Optional<java.util.Map<java.lang.String,java.lang.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<java.lang.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<java.lang.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

getMonthdays

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

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

getPaused

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

Indicates if the schedule should be paused or not.

getRecurring

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

Indicates if the schedule will be recurring or not.

getRunNextInterval

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

Use to choose to run the schedule when the scheduler 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 Optional<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)

getScheduleName

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

Unique name for the schedule.

getScheduleType

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

Only "snapshot" is supported at this time.

getStartingDate

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

Indicates the date the first time the schedule began or will begin.

getToBeDeleted

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

Indicates if the schedule is marked for deletion.

getWeekdays

public Optional<ApiWeekday[]> getWeekdays()

Day of the week the snapshot is to be created. The day of the week starts at Sunday with the value of "0" and an offset of "1." Monday has a value of "1" with an offset of "1", etc.

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 ApiModifyScheduleRequest.Builder builder()

asBuilder

public final ApiModifyScheduleRequest.Builder asBuilder()