Package com.azure.resourcemanager.labservices.models

Class RecurrencePattern

java.lang.Object

com.azure.resourcemanager.labservices.models.RecurrencePattern

public final class RecurrencePattern
extends Object

Recurrence pattern of a lab schedule.

Constructor Summary

Constructors

Constructor	Description
RecurrencePattern()

Method Summary

Modifier and Type	Method	Description
LocalDate	expirationDate()	Get the expirationDate property: When the recurrence will expire.
RecurrenceFrequency	frequency()	Get the frequency property: The frequency of the recurrence.
Integer	interval()	Get the interval property: The interval to invoke the schedule on.
void	validate()	Validates the instance.
List<WeekDay>	weekDays()	Get the weekDays property: The week days the schedule runs.
RecurrencePattern	withExpirationDate(LocalDate expirationDate)	Set the expirationDate property: When the recurrence will expire.
RecurrencePattern	withFrequency(RecurrenceFrequency frequency)	Set the frequency property: The frequency of the recurrence.
RecurrencePattern	withInterval(Integer interval)	Set the interval property: The interval to invoke the schedule on.
RecurrencePattern	withWeekDays(List<WeekDay> weekDays)	Set the weekDays property: The week days the schedule runs.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecurrencePattern

public RecurrencePattern()

Method Detail

frequency

public RecurrenceFrequency frequency()

Get the frequency property: The frequency of the recurrence.

Returns:

the frequency value.

withFrequency

public RecurrencePattern withFrequency(RecurrenceFrequency frequency)

Set the frequency property: The frequency of the recurrence.

Parameters:

frequency - the frequency value to set.

Returns:

the RecurrencePattern object itself.

weekDays

public List<WeekDay> weekDays()

Get the weekDays property: The week days the schedule runs. Used for when the Frequency is set to Weekly.

Returns:

the weekDays value.

withWeekDays

public RecurrencePattern withWeekDays(List<WeekDay> weekDays)

Set the weekDays property: The week days the schedule runs. Used for when the Frequency is set to Weekly.

Parameters:

weekDays - the weekDays value to set.

Returns:

the RecurrencePattern object itself.

interval

public Integer interval()

Get the interval property: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.

Returns:

the interval value.

withInterval

public RecurrencePattern withInterval(Integer interval)

Set the interval property: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.

Parameters:

interval - the interval value to set.

Returns:

the RecurrencePattern object itself.

expirationDate

public LocalDate expirationDate()

Get the expirationDate property: When the recurrence will expire. This date is inclusive.

Returns:

the expirationDate value.

withExpirationDate

public RecurrencePattern withExpirationDate(LocalDate expirationDate)

Set the expirationDate property: When the recurrence will expire. This date is inclusive.

Parameters:

expirationDate - the expirationDate value to set.

Returns:

the RecurrencePattern object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.