Package com.softlayer.api.service.network.storage

Interface Schedule.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Schedule

@ApiService("SoftLayer_Network_Storage_Schedule")
public static interface Schedule.Service
extends Service

Schedules can be created for select Storage services, such as iscsi. These schedules are used to perform various tasks such as scheduling snapshots or synchronizing replicants.

The schedule service can be used to create, edit, or delete a schedule. Schedules are defined by the properties associated with them to specify values such as the start date, interval, or end date of the schedule.

See Also:

SoftLayer_Network_Storage_Schedule

Method Summary

Modifier and Type	Method	Description
Schedule.ServiceAsync	asAsync()	Get an async version of this service
Schedule	createObject(Schedule templateObject)	Create a nas volume schedule
Boolean	deleteObject()	Delete a network storage schedule.
Boolean	editObject(Schedule templateObject)	Edit a nas volume schedule
String	getDay()	The hour parameter of this schedule.
String	getDayOfMonth()	The day of the month parameter of this schedule.
String	getDayOfWeek()	The day of the week parameter of this schedule.
List<Event>	getEvents()	Events which have been created as the result of a schedule execution.
String	getHour()	The hour parameter of this schedule.
String	getMinute()	The minute parameter of this schedule.
String	getMonthOfYear()	The month of the year parameter of this schedule.
Schedule	getObject()
Partnership	getPartnership()	The associated partnership for a schedule.
List<Property>	getProperties()	Properties used for configuration of a schedule.
List<Storage>	getReplicaSnapshots()	Replica snapshots which have been created as the result of this schedule's execution.
String	getRetentionCount()	The number of snapshots this schedule is configured to retain.
String	getSecond()	The minute parameter of this schedule.
List<Storage>	getSnapshots()	Snapshots which have been created as the result of this schedule's execution.
Type	getType()	The type provides a standardized definition for a schedule.
Storage	getVolume()	The associated volume for a schedule.
void	setMask(Schedule.Mask mask)
Schedule.Mask	withMask()	Use the existing mask on this service or create it if not present
Schedule.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details

asAsync

Schedule.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Schedule.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Schedule.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Schedule.Mask mask)

createObject

@ApiMethod
Schedule createObject(Schedule templateObject)

Create a nas volume schedule

See Also:

SoftLayer_Network_Storage_Schedule::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

Delete a network storage schedule. '''This cannot be undone.''' ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a schedule;

See Also:

SoftLayer_Network_Storage_Schedule::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Schedule templateObject)

Edit a nas volume schedule

See Also:

SoftLayer_Network_Storage_Schedule::editObject

getObject

@ApiMethod(instanceRequired=true)
Schedule getObject()

See Also:

SoftLayer_Network_Storage_Schedule::getObject

getDay

@ApiMethod(instanceRequired=true)
String getDay()

The hour parameter of this schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getDay

getDayOfMonth

@ApiMethod(instanceRequired=true)
String getDayOfMonth()

The day of the month parameter of this schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getDayOfMonth

getDayOfWeek

@ApiMethod(instanceRequired=true)
String getDayOfWeek()

The day of the week parameter of this schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getDayOfWeek

getEvents

@ApiMethod(instanceRequired=true)
List<Event> getEvents()

Events which have been created as the result of a schedule execution.

See Also:

SoftLayer_Network_Storage_Schedule::getEvents

getHour

@ApiMethod(instanceRequired=true)
String getHour()

The hour parameter of this schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getHour

getMinute

@ApiMethod(instanceRequired=true)
String getMinute()

The minute parameter of this schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getMinute

getMonthOfYear

@ApiMethod(instanceRequired=true)
String getMonthOfYear()

The month of the year parameter of this schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getMonthOfYear

getPartnership

@ApiMethod(instanceRequired=true)
Partnership getPartnership()

The associated partnership for a schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getPartnership

getProperties

@ApiMethod(instanceRequired=true)
List<Property> getProperties()

Properties used for configuration of a schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getProperties

getReplicaSnapshots

@ApiMethod(instanceRequired=true)
List<Storage> getReplicaSnapshots()

Replica snapshots which have been created as the result of this schedule's execution.

See Also:

SoftLayer_Network_Storage_Schedule::getReplicaSnapshots

getRetentionCount

@ApiMethod(instanceRequired=true)
String getRetentionCount()

The number of snapshots this schedule is configured to retain.

See Also:

SoftLayer_Network_Storage_Schedule::getRetentionCount

getSecond

@ApiMethod(instanceRequired=true)
String getSecond()

The minute parameter of this schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getSecond

getSnapshots

@ApiMethod(instanceRequired=true)
List<Storage> getSnapshots()

Snapshots which have been created as the result of this schedule's execution.

See Also:

SoftLayer_Network_Storage_Schedule::getSnapshots

getType

@ApiMethod(instanceRequired=true)
Type getType()

The type provides a standardized definition for a schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getType

getVolume

@ApiMethod(instanceRequired=true)
Storage getVolume()

The associated volume for a schedule.

See Also:

SoftLayer_Network_Storage_Schedule::getVolume