public class ScheduledInstanceRecurrence
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Describes the recurring schedule for a Scheduled Instance.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
frequency
The frequency (
Daily , Weekly , or
Monthly ). |
private java.lang.Integer |
interval
The interval quantity.
|
private SdkInternalList<java.lang.Integer> |
occurrenceDaySet
The days.
|
private java.lang.Boolean |
occurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified
week or month.
|
private java.lang.String |
occurrenceUnit
The unit for
occurrenceDaySet (DayOfWeek or
DayOfMonth ). |
Constructor and Description |
---|
ScheduledInstanceRecurrence() |
Modifier and Type | Method and Description |
---|---|
ScheduledInstanceRecurrence |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getFrequency()
The frequency (
Daily , Weekly , or
Monthly ). |
java.lang.Integer |
getInterval()
The interval quantity.
|
java.util.List<java.lang.Integer> |
getOccurrenceDaySet()
The days.
|
java.lang.Boolean |
getOccurrenceRelativeToEnd()
Indicates whether the occurrence is relative to the end of the specified
week or month.
|
java.lang.String |
getOccurrenceUnit()
The unit for
occurrenceDaySet (DayOfWeek or
DayOfMonth ). |
int |
hashCode() |
java.lang.Boolean |
isOccurrenceRelativeToEnd()
Indicates whether the occurrence is relative to the end of the specified
week or month.
|
void |
setFrequency(java.lang.String frequency)
The frequency (
Daily , Weekly , or
Monthly ). |
void |
setInterval(java.lang.Integer interval)
The interval quantity.
|
void |
setOccurrenceDaySet(java.util.Collection<java.lang.Integer> occurrenceDaySet)
The days.
|
void |
setOccurrenceRelativeToEnd(java.lang.Boolean occurrenceRelativeToEnd)
Indicates whether the occurrence is relative to the end of the specified
week or month.
|
void |
setOccurrenceUnit(java.lang.String occurrenceUnit)
The unit for
occurrenceDaySet (DayOfWeek or
DayOfMonth ). |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ScheduledInstanceRecurrence |
withFrequency(java.lang.String frequency)
The frequency (
Daily , Weekly , or
Monthly ). |
ScheduledInstanceRecurrence |
withInterval(java.lang.Integer interval)
The interval quantity.
|
ScheduledInstanceRecurrence |
withOccurrenceDaySet(java.util.Collection<java.lang.Integer> occurrenceDaySet)
The days.
|
ScheduledInstanceRecurrence |
withOccurrenceDaySet(java.lang.Integer... occurrenceDaySet)
The days.
|
ScheduledInstanceRecurrence |
withOccurrenceRelativeToEnd(java.lang.Boolean occurrenceRelativeToEnd)
Indicates whether the occurrence is relative to the end of the specified
week or month.
|
ScheduledInstanceRecurrence |
withOccurrenceUnit(java.lang.String occurrenceUnit)
The unit for
occurrenceDaySet (DayOfWeek or
DayOfMonth ). |
private java.lang.String frequency
The frequency (Daily
, Weekly
, or
Monthly
).
private java.lang.Integer interval
The interval quantity. The interval unit depends on the value of
frequency
. For example, every 2 weeks or every 2 months.
private SdkInternalList<java.lang.Integer> occurrenceDaySet
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).
private java.lang.Boolean occurrenceRelativeToEnd
Indicates whether the occurrence is relative to the end of the specified week or month.
private java.lang.String occurrenceUnit
The unit for occurrenceDaySet
(DayOfWeek
or
DayOfMonth
).
public void setFrequency(java.lang.String frequency)
The frequency (Daily
, Weekly
, or
Monthly
).
frequency
- The frequency (Daily
, Weekly
, or
Monthly
).public java.lang.String getFrequency()
The frequency (Daily
, Weekly
, or
Monthly
).
Daily
, Weekly
, or
Monthly
).public ScheduledInstanceRecurrence withFrequency(java.lang.String frequency)
The frequency (Daily
, Weekly
, or
Monthly
).
frequency
- The frequency (Daily
, Weekly
, or
Monthly
).public void setInterval(java.lang.Integer interval)
The interval quantity. The interval unit depends on the value of
frequency
. For example, every 2 weeks or every 2 months.
interval
- The interval quantity. The interval unit depends on the value of
frequency
. For example, every 2 weeks or every 2
months.public java.lang.Integer getInterval()
The interval quantity. The interval unit depends on the value of
frequency
. For example, every 2 weeks or every 2 months.
frequency
. For example, every 2 weeks or every 2
months.public ScheduledInstanceRecurrence withInterval(java.lang.Integer interval)
The interval quantity. The interval unit depends on the value of
frequency
. For example, every 2 weeks or every 2 months.
interval
- The interval quantity. The interval unit depends on the value of
frequency
. For example, every 2 weeks or every 2
months.public java.util.List<java.lang.Integer> getOccurrenceDaySet()
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).
public void setOccurrenceDaySet(java.util.Collection<java.lang.Integer> occurrenceDaySet)
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).
occurrenceDaySet
- 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).public ScheduledInstanceRecurrence withOccurrenceDaySet(java.lang.Integer... occurrenceDaySet)
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).
NOTE: This method appends the values to the existing list (if
any). Use setOccurrenceDaySet(java.util.Collection)
or
withOccurrenceDaySet(java.util.Collection)
if you want to
override the existing values.
occurrenceDaySet
- 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).public ScheduledInstanceRecurrence withOccurrenceDaySet(java.util.Collection<java.lang.Integer> occurrenceDaySet)
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).
occurrenceDaySet
- 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).public void setOccurrenceRelativeToEnd(java.lang.Boolean occurrenceRelativeToEnd)
Indicates whether the occurrence is relative to the end of the specified week or month.
occurrenceRelativeToEnd
- Indicates whether the occurrence is relative to the end of the
specified week or month.public java.lang.Boolean getOccurrenceRelativeToEnd()
Indicates whether the occurrence is relative to the end of the specified week or month.
public ScheduledInstanceRecurrence withOccurrenceRelativeToEnd(java.lang.Boolean occurrenceRelativeToEnd)
Indicates whether the occurrence is relative to the end of the specified week or month.
occurrenceRelativeToEnd
- Indicates whether the occurrence is relative to the end of the
specified week or month.public java.lang.Boolean isOccurrenceRelativeToEnd()
Indicates whether the occurrence is relative to the end of the specified week or month.
public void setOccurrenceUnit(java.lang.String occurrenceUnit)
The unit for occurrenceDaySet
(DayOfWeek
or
DayOfMonth
).
occurrenceUnit
- The unit for occurrenceDaySet
(DayOfWeek
or DayOfMonth
).public java.lang.String getOccurrenceUnit()
The unit for occurrenceDaySet
(DayOfWeek
or
DayOfMonth
).
occurrenceDaySet
(
DayOfWeek
or DayOfMonth
).public ScheduledInstanceRecurrence withOccurrenceUnit(java.lang.String occurrenceUnit)
The unit for occurrenceDaySet
(DayOfWeek
or
DayOfMonth
).
occurrenceUnit
- The unit for occurrenceDaySet
(DayOfWeek
or DayOfMonth
).public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ScheduledInstanceRecurrence clone()
clone
in class java.lang.Object