com.softlayer.api.service.network.storage.Schedule

@ApiType("SoftLayer_Network_Storage_Schedule")
public class Schedule
extends Entity

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.

See Also:: SoftLayer_Network_Storage_Schedule

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Schedule.Mask`
`static interface`	`Schedule.Service`	Schedules can be created for select Storage services, such as iscsi.
`static interface`	`Schedule.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Long`	`active`	A flag which determines if a schedule is active.
`protected boolean`	`activeSpecified`
`protected GregorianCalendar`	`createDate`	The date a schedule was created.
`protected boolean`	`createDateSpecified`
`protected String`	`day`	The hour parameter of this schedule.
`protected String`	`dayOfMonth`	The day of the month parameter of this schedule.
`protected String`	`dayOfWeek`	The day of the week parameter of this schedule.
`protected Long`	`eventCount`	A count of events which have been created as the result of a schedule execution.
`protected List<Event>`	`events`	Events which have been created as the result of a schedule execution.
`protected String`	`hour`	The hour parameter of this schedule.
`protected Long`	`id`	A schedule's internal identifier.
`protected boolean`	`idSpecified`
`protected String`	`minute`	The minute parameter of this schedule.
`protected GregorianCalendar`	`modifyDate`	The date a schedule was last modified.
`protected boolean`	`modifyDateSpecified`
`protected String`	`monthOfYear`	The month of the year parameter of this schedule.
`protected String`	`name`	A schedule's name, for example 'Daily'.
`protected boolean`	`nameSpecified`
`protected Partnership`	`partnership`	The associated partnership for a schedule.
`protected Long`	`partnershipId`	The partnership id which a schedule is associated with.
`protected boolean`	`partnershipIdSpecified`
`protected List<Property>`	`properties`	Properties used for configuration of a schedule.
`protected Long`	`propertyCount`	A count of properties used for configuration of a schedule.
`protected Long`	`replicaSnapshotCount`	A count of replica snapshots which have been created as the result of this schedule's execution.
`protected List<Storage>`	`replicaSnapshots`	Replica snapshots which have been created as the result of this schedule's execution.
`protected String`	`retentionCount`	The number of snapshots this schedule is configured to retain.
`protected String`	`second`	The minute parameter of this schedule.
`protected Long`	`snapshotCount`	A count of snapshots which have been created as the result of this schedule's execution.
`protected List<Storage>`	`snapshots`	Snapshots which have been created as the result of this schedule's execution.
`protected Type`	`type`	The type provides a standardized definition for a schedule.
`protected Long`	`typeId`	The type id which a schedule is associated with.
`protected boolean`	`typeIdSpecified`
`protected Storage`	`volume`	The associated volume for a schedule.
`protected Long`	`volumeId`	The volume id which a schedule is associated with.
`protected boolean`	`volumeIdSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Schedule()

Method Summary

Modifier and Type	Method	Description
`Schedule.Service`	`asService(ApiClient client)`
`Long`	`getActive()`
`GregorianCalendar`	`getCreateDate()`
`String`	`getDay()`
`String`	`getDayOfMonth()`
`String`	`getDayOfWeek()`
`Long`	`getEventCount()`
`List<Event>`	`getEvents()`
`String`	`getHour()`
`Long`	`getId()`
`String`	`getMinute()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getMonthOfYear()`
`String`	`getName()`
`Partnership`	`getPartnership()`
`Long`	`getPartnershipId()`
`List<Property>`	`getProperties()`
`Long`	`getPropertyCount()`
`Long`	`getReplicaSnapshotCount()`
`List<Storage>`	`getReplicaSnapshots()`
`String`	`getRetentionCount()`
`String`	`getSecond()`
`Long`	`getSnapshotCount()`
`List<Storage>`	`getSnapshots()`
`Type`	`getType()`
`Long`	`getTypeId()`
`Storage`	`getVolume()`
`Long`	`getVolumeId()`
`boolean`	`isActiveSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isPartnershipIdSpecified()`
`boolean`	`isTypeIdSpecified()`
`boolean`	`isVolumeIdSpecified()`
`static Schedule.Service`	`service(ApiClient client)`
`static Schedule.Service`	`service(ApiClient client, Long id)`
`void`	`setActive(Long active)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setDay(String day)`
`void`	`setDayOfMonth(String dayOfMonth)`
`void`	`setDayOfWeek(String dayOfWeek)`
`void`	`setEventCount(Long eventCount)`
`void`	`setHour(String hour)`
`void`	`setId(Long id)`
`void`	`setMinute(String minute)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setMonthOfYear(String monthOfYear)`
`void`	`setName(String name)`
`void`	`setPartnership(Partnership partnership)`
`void`	`setPartnershipId(Long partnershipId)`
`void`	`setPropertyCount(Long propertyCount)`
`void`	`setReplicaSnapshotCount(Long replicaSnapshotCount)`
`void`	`setRetentionCount(String retentionCount)`
`void`	`setSecond(String second)`
`void`	`setSnapshotCount(Long snapshotCount)`
`void`	`setType(Type type)`
`void`	`setTypeId(Long typeId)`
`void`	`setVolume(Storage volume)`
`void`	`setVolumeId(Long volumeId)`
`void`	`unsetActive()`
`void`	`unsetCreateDate()`
`void`	`unsetId()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetPartnershipId()`
`void`	`unsetTypeId()`
`void`	`unsetVolumeId()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- day
  
  @ApiProperty protected String day
  
  The hour parameter of this schedule.
- dayOfMonth
  
  @ApiProperty protected String dayOfMonth
  
  The day of the month parameter of this schedule.
- dayOfWeek
  
  @ApiProperty protected String dayOfWeek
  
  The day of the week parameter of this schedule.
- events
  
  @ApiProperty protected List<Event> events
  
  Events which have been created as the result of a schedule execution.
- hour
  
  @ApiProperty protected String hour
  
  The hour parameter of this schedule.
- minute
  
  @ApiProperty protected String minute
  
  The minute parameter of this schedule.
- monthOfYear
  
  @ApiProperty protected String monthOfYear
  
  The month of the year parameter of this schedule.
- partnership
  
  @ApiProperty protected Partnership partnership
  
  The associated partnership for a schedule.
- properties
  
  @ApiProperty protected List<Property> properties
  
  Properties used for configuration of a schedule.
- replicaSnapshots
  
  @ApiProperty protected List<Storage> replicaSnapshots
  
  Replica snapshots which have been created as the result of this schedule's execution.
- retentionCount
  
  @ApiProperty protected String retentionCount
  
  The number of snapshots this schedule is configured to retain.
- second
  
  @ApiProperty protected String second
  
  The minute parameter of this schedule.
- snapshots
  
  @ApiProperty protected List<Storage> snapshots
  
  Snapshots which have been created as the result of this schedule's execution.
- type
  
  @ApiProperty protected Type type
  
  The type provides a standardized definition for a schedule.
- volume
  
  @ApiProperty protected Storage volume
  
  The associated volume for a schedule.
- active
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long active
  
  A flag which determines if a schedule is active.
- activeSpecified
  
  protected boolean activeSpecified
- createDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
  
  The date a schedule was created.
- createDateSpecified
  
  protected boolean createDateSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  A schedule's internal identifier.
- idSpecified
  
  protected boolean idSpecified
- modifyDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
  
  The date a schedule was last modified.
- modifyDateSpecified
  
  protected boolean modifyDateSpecified
- name
  
  @ApiProperty(canBeNullOrNotSet=true) protected String name
  
  A schedule's name, for example 'Daily'.
- nameSpecified
  
  protected boolean nameSpecified
- partnershipId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long partnershipId
  
  The partnership id which a schedule is associated with.
- partnershipIdSpecified
  
  protected boolean partnershipIdSpecified
- typeId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long typeId
  
  The type id which a schedule is associated with.
- typeIdSpecified
  
  protected boolean typeIdSpecified
- volumeId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long volumeId
  
  The volume id which a schedule is associated with.
- volumeIdSpecified
  
  protected boolean volumeIdSpecified
- eventCount
  
  @ApiProperty protected Long eventCount
  
  A count of events which have been created as the result of a schedule execution.
- propertyCount
  
  @ApiProperty protected Long propertyCount
  
  A count of properties used for configuration of a schedule.
- replicaSnapshotCount
  
  @ApiProperty protected Long replicaSnapshotCount
  
  A count of replica snapshots which have been created as the result of this schedule's execution.
- snapshotCount
  
  @ApiProperty protected Long snapshotCount
  
  A count of snapshots which have been created as the result of this schedule's execution.
Constructor Details
- Schedule
  
  public Schedule()
Method Details
- getDay
  
  public String getDay()
- setDay
  
  public void setDay(String day)
- getDayOfMonth
  
  public String getDayOfMonth()
- setDayOfMonth
  
  public void setDayOfMonth(String dayOfMonth)
- getDayOfWeek
  
  public String getDayOfWeek()
- setDayOfWeek
  
  public void setDayOfWeek(String dayOfWeek)
- getEvents
  
  public List<Event> getEvents()
- getHour
  
  public String getHour()
- setHour
  
  public void setHour(String hour)
- getMinute
  
  public String getMinute()
- setMinute
  
  public void setMinute(String minute)
- getMonthOfYear
  
  public String getMonthOfYear()
- setMonthOfYear
  
  public void setMonthOfYear(String monthOfYear)
- getPartnership
  
  public Partnership getPartnership()
- setPartnership
  
  public void setPartnership(Partnership partnership)
- getProperties
  
  public List<Property> getProperties()
- getReplicaSnapshots
  
  public List<Storage> getReplicaSnapshots()
- getRetentionCount
  
  public String getRetentionCount()
- setRetentionCount
  
  public void setRetentionCount(String retentionCount)
- getSecond
  
  public String getSecond()
- setSecond
  
  public void setSecond(String second)
- getSnapshots
  
  public List<Storage> getSnapshots()
- getType
  
  public Type getType()
- setType
  
  public void setType(Type type)
- getVolume
  
  public Storage getVolume()
- setVolume
  
  public void setVolume(Storage volume)
- getActive
  
  public Long getActive()
- setActive
  
  public void setActive(Long active)
- isActiveSpecified
  
  public boolean isActiveSpecified()
- unsetActive
  
  public void unsetActive()
- getCreateDate
  
  public GregorianCalendar getCreateDate()
- setCreateDate
  
  public void setCreateDate(GregorianCalendar createDate)
- isCreateDateSpecified
  
  public boolean isCreateDateSpecified()
- unsetCreateDate
  
  public void unsetCreateDate()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getModifyDate
  
  public GregorianCalendar getModifyDate()
- setModifyDate
  
  public void setModifyDate(GregorianCalendar modifyDate)
- isModifyDateSpecified
  
  public boolean isModifyDateSpecified()
- unsetModifyDate
  
  public void unsetModifyDate()
- getName
  
  public String getName()
- setName
  
  public void setName(String name)
- isNameSpecified
  
  public boolean isNameSpecified()
- unsetName
  
  public void unsetName()
- getPartnershipId
  
  public Long getPartnershipId()
- setPartnershipId
  
  public void setPartnershipId(Long partnershipId)
- isPartnershipIdSpecified
  
  public boolean isPartnershipIdSpecified()
- unsetPartnershipId
  
  public void unsetPartnershipId()
- getTypeId
  
  public Long getTypeId()
- setTypeId
  
  public void setTypeId(Long typeId)
- isTypeIdSpecified
  
  public boolean isTypeIdSpecified()
- unsetTypeId
  
  public void unsetTypeId()
- getVolumeId
  
  public Long getVolumeId()
- setVolumeId
  
  public void setVolumeId(Long volumeId)
- isVolumeIdSpecified
  
  public boolean isVolumeIdSpecified()
- unsetVolumeId
  
  public void unsetVolumeId()
- getEventCount
  
  public Long getEventCount()
- setEventCount
  
  public void setEventCount(Long eventCount)
- getPropertyCount
  
  public Long getPropertyCount()
- setPropertyCount
  
  public void setPropertyCount(Long propertyCount)
- getReplicaSnapshotCount
  
  public Long getReplicaSnapshotCount()
- setReplicaSnapshotCount
  
  public void setReplicaSnapshotCount(Long replicaSnapshotCount)
- getSnapshotCount
  
  public Long getSnapshotCount()
- setSnapshotCount
  
  public void setSnapshotCount(Long snapshotCount)
- asService
  
  public Schedule.Service asService(ApiClient client)
- service
  
  public static Schedule.Service service(ApiClient client)
- service
  
  public static Schedule.Service service(ApiClient client, Long id)

Class Schedule

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details