Class ScheduledInstanceRecurrenceRequest
- java.lang.Object
-
- com.amazonaws.services.ec2.model.ScheduledInstanceRecurrenceRequest
-
- All Implemented Interfaces:
Serializable,Cloneable
public class ScheduledInstanceRecurrenceRequest extends Object implements Serializable, Cloneable
Describes the recurring schedule for a Scheduled Instance.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ScheduledInstanceRecurrenceRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ScheduledInstanceRecurrenceRequestclone()booleanequals(Object obj)StringgetFrequency()The frequency (Daily,Weekly, orMonthly).IntegergetInterval()The interval quantity.List<Integer>getOccurrenceDays()The days.BooleangetOccurrenceRelativeToEnd()Indicates whether the occurrence is relative to the end of the specified week or month.StringgetOccurrenceUnit()The unit forOccurrenceDays(DayOfWeekorDayOfMonth).inthashCode()BooleanisOccurrenceRelativeToEnd()Indicates whether the occurrence is relative to the end of the specified week or month.voidsetFrequency(String frequency)The frequency (Daily,Weekly, orMonthly).voidsetInterval(Integer interval)The interval quantity.voidsetOccurrenceDays(Collection<Integer> occurrenceDays)The days.voidsetOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)Indicates whether the occurrence is relative to the end of the specified week or month.voidsetOccurrenceUnit(String occurrenceUnit)The unit forOccurrenceDays(DayOfWeekorDayOfMonth).StringtoString()Returns a string representation of this object; useful for testing and debugging.ScheduledInstanceRecurrenceRequestwithFrequency(String frequency)The frequency (Daily,Weekly, orMonthly).ScheduledInstanceRecurrenceRequestwithInterval(Integer interval)The interval quantity.ScheduledInstanceRecurrenceRequestwithOccurrenceDays(Integer... occurrenceDays)The days.ScheduledInstanceRecurrenceRequestwithOccurrenceDays(Collection<Integer> occurrenceDays)The days.ScheduledInstanceRecurrenceRequestwithOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)Indicates whether the occurrence is relative to the end of the specified week or month.ScheduledInstanceRecurrenceRequestwithOccurrenceUnit(String occurrenceUnit)The unit forOccurrenceDays(DayOfWeekorDayOfMonth).
-
-
-
Method Detail
-
setFrequency
public void setFrequency(String frequency)
The frequency (
Daily,Weekly, orMonthly).- Parameters:
frequency- The frequency (Daily,Weekly, orMonthly).
-
getFrequency
public String getFrequency()
The frequency (
Daily,Weekly, orMonthly).- Returns:
- The frequency (
Daily,Weekly, orMonthly).
-
withFrequency
public ScheduledInstanceRecurrenceRequest withFrequency(String frequency)
The frequency (
Daily,Weekly, orMonthly).- Parameters:
frequency- The frequency (Daily,Weekly, orMonthly).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInterval
public void setInterval(Integer interval)
The interval quantity. The interval unit depends on the value of
Frequency. For example, every 2 weeks or every 2 months.- Parameters:
interval- The interval quantity. The interval unit depends on the value ofFrequency. For example, every 2 weeks or every 2 months.
-
getInterval
public Integer getInterval()
The interval quantity. The interval unit depends on the value of
Frequency. For example, every 2 weeks or every 2 months.- Returns:
- The interval quantity. The interval unit depends on the value of
Frequency. For example, every 2 weeks or every 2 months.
-
withInterval
public ScheduledInstanceRecurrenceRequest withInterval(Integer interval)
The interval quantity. The interval unit depends on the value of
Frequency. For example, every 2 weeks or every 2 months.- Parameters:
interval- The interval quantity. The interval unit depends on the value ofFrequency. For example, every 2 weeks or every 2 months.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getOccurrenceDays
public List<Integer> getOccurrenceDays()
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
- Returns:
- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
-
setOccurrenceDays
public void setOccurrenceDays(Collection<Integer> occurrenceDays)
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
- Parameters:
occurrenceDays- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
-
withOccurrenceDays
public ScheduledInstanceRecurrenceRequest withOccurrenceDays(Integer... occurrenceDays)
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
NOTE: This method appends the values to the existing list (if any). Use
setOccurrenceDays(java.util.Collection)orwithOccurrenceDays(java.util.Collection)if you want to override the existing values.- Parameters:
occurrenceDays- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withOccurrenceDays
public ScheduledInstanceRecurrenceRequest withOccurrenceDays(Collection<Integer> occurrenceDays)
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
- Parameters:
occurrenceDays- The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOccurrenceRelativeToEnd
public void setOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
- Parameters:
occurrenceRelativeToEnd- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
-
getOccurrenceRelativeToEnd
public Boolean getOccurrenceRelativeToEnd()
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
- Returns:
- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
-
withOccurrenceRelativeToEnd
public ScheduledInstanceRecurrenceRequest withOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
- Parameters:
occurrenceRelativeToEnd- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isOccurrenceRelativeToEnd
public Boolean isOccurrenceRelativeToEnd()
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
- Returns:
- Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
-
setOccurrenceUnit
public void setOccurrenceUnit(String occurrenceUnit)
The unit for
OccurrenceDays(DayOfWeekorDayOfMonth). This value is required for a monthly schedule. You can't specifyDayOfWeekwith a weekly schedule. You can't specify this value with a daily schedule.- Parameters:
occurrenceUnit- The unit forOccurrenceDays(DayOfWeekorDayOfMonth). This value is required for a monthly schedule. You can't specifyDayOfWeekwith a weekly schedule. You can't specify this value with a daily schedule.
-
getOccurrenceUnit
public String getOccurrenceUnit()
The unit for
OccurrenceDays(DayOfWeekorDayOfMonth). This value is required for a monthly schedule. You can't specifyDayOfWeekwith a weekly schedule. You can't specify this value with a daily schedule.- Returns:
- The unit for
OccurrenceDays(DayOfWeekorDayOfMonth). This value is required for a monthly schedule. You can't specifyDayOfWeekwith a weekly schedule. You can't specify this value with a daily schedule.
-
withOccurrenceUnit
public ScheduledInstanceRecurrenceRequest withOccurrenceUnit(String occurrenceUnit)
The unit for
OccurrenceDays(DayOfWeekorDayOfMonth). This value is required for a monthly schedule. You can't specifyDayOfWeekwith a weekly schedule. You can't specify this value with a daily schedule.- Parameters:
occurrenceUnit- The unit forOccurrenceDays(DayOfWeekorDayOfMonth). This value is required for a monthly schedule. You can't specifyDayOfWeekwith a weekly schedule. You can't specify this value with a daily schedule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toStringin classObject- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ScheduledInstanceRecurrenceRequest clone()
-
-