Class ScalingSchedule
java.lang.Object
com.azure.resourcemanager.desktopvirtualization.models.ScalingSchedule
Scaling plan schedule.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the daysOfWeek property: Set of days of the week on which this schedule is active.name()
Get the name property: Name of the scaling schedule.Get the offPeakLoadBalancingAlgorithm property: Load balancing algorithm for off-peak period.Get the offPeakStartTime property: Starting time for off-peak period.Get the peakLoadBalancingAlgorithm property: Load balancing algorithm for peak period.Get the peakStartTime property: Starting time for peak period.Get the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.Get the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.Get the rampDownLoadBalancingAlgorithm property: Load balancing algorithm for ramp down period.Get the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.Get the rampDownNotificationMessage property: Notification message for users during ramp down period.Get the rampDownStartTime property: Starting time for ramp down period.Get the rampDownStopHostsWhen property: Specifies when to stop hosts during ramp down period.Get the rampDownWaitTimeMinutes property: Number of minutes to wait to stop hosts during ramp down period.Get the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.Get the rampUpLoadBalancingAlgorithm property: Load balancing algorithm for ramp up period.Get the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.Get the rampUpStartTime property: Starting time for ramp up period.void
validate()
Validates the instance.withDaysOfWeek
(List<ScalingScheduleDaysOfWeekItem> daysOfWeek) Set the daysOfWeek property: Set of days of the week on which this schedule is active.Set the name property: Name of the scaling schedule.withOffPeakLoadBalancingAlgorithm
(SessionHostLoadBalancingAlgorithm offPeakLoadBalancingAlgorithm) Set the offPeakLoadBalancingAlgorithm property: Load balancing algorithm for off-peak period.withOffPeakStartTime
(Time offPeakStartTime) Set the offPeakStartTime property: Starting time for off-peak period.withPeakLoadBalancingAlgorithm
(SessionHostLoadBalancingAlgorithm peakLoadBalancingAlgorithm) Set the peakLoadBalancingAlgorithm property: Load balancing algorithm for peak period.withPeakStartTime
(Time peakStartTime) Set the peakStartTime property: Starting time for peak period.withRampDownCapacityThresholdPct
(Integer rampDownCapacityThresholdPct) Set the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.withRampDownForceLogoffUsers
(Boolean rampDownForceLogoffUsers) Set the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.withRampDownLoadBalancingAlgorithm
(SessionHostLoadBalancingAlgorithm rampDownLoadBalancingAlgorithm) Set the rampDownLoadBalancingAlgorithm property: Load balancing algorithm for ramp down period.withRampDownMinimumHostsPct
(Integer rampDownMinimumHostsPct) Set the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.withRampDownNotificationMessage
(String rampDownNotificationMessage) Set the rampDownNotificationMessage property: Notification message for users during ramp down period.withRampDownStartTime
(Time rampDownStartTime) Set the rampDownStartTime property: Starting time for ramp down period.withRampDownStopHostsWhen
(StopHostsWhen rampDownStopHostsWhen) Set the rampDownStopHostsWhen property: Specifies when to stop hosts during ramp down period.withRampDownWaitTimeMinutes
(Integer rampDownWaitTimeMinutes) Set the rampDownWaitTimeMinutes property: Number of minutes to wait to stop hosts during ramp down period.withRampUpCapacityThresholdPct
(Integer rampUpCapacityThresholdPct) Set the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.withRampUpLoadBalancingAlgorithm
(SessionHostLoadBalancingAlgorithm rampUpLoadBalancingAlgorithm) Set the rampUpLoadBalancingAlgorithm property: Load balancing algorithm for ramp up period.withRampUpMinimumHostsPct
(Integer rampUpMinimumHostsPct) Set the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.withRampUpStartTime
(Time rampUpStartTime) Set the rampUpStartTime property: Starting time for ramp up period.
-
Constructor Details
-
ScalingSchedule
public ScalingSchedule()
-
-
Method Details
-
name
Get the name property: Name of the scaling schedule.- Returns:
- the name value.
-
withName
Set the name property: Name of the scaling schedule.- Parameters:
name
- the name value to set.- Returns:
- the ScalingSchedule object itself.
-
daysOfWeek
Get the daysOfWeek property: Set of days of the week on which this schedule is active.- Returns:
- the daysOfWeek value.
-
withDaysOfWeek
Set the daysOfWeek property: Set of days of the week on which this schedule is active.- Parameters:
daysOfWeek
- the daysOfWeek value to set.- Returns:
- the ScalingSchedule object itself.
-
rampUpStartTime
Get the rampUpStartTime property: Starting time for ramp up period.- Returns:
- the rampUpStartTime value.
-
withRampUpStartTime
Set the rampUpStartTime property: Starting time for ramp up period.- Parameters:
rampUpStartTime
- the rampUpStartTime value to set.- Returns:
- the ScalingSchedule object itself.
-
rampUpLoadBalancingAlgorithm
Get the rampUpLoadBalancingAlgorithm property: Load balancing algorithm for ramp up period.- Returns:
- the rampUpLoadBalancingAlgorithm value.
-
withRampUpLoadBalancingAlgorithm
public ScalingSchedule withRampUpLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm rampUpLoadBalancingAlgorithm) Set the rampUpLoadBalancingAlgorithm property: Load balancing algorithm for ramp up period.- Parameters:
rampUpLoadBalancingAlgorithm
- the rampUpLoadBalancingAlgorithm value to set.- Returns:
- the ScalingSchedule object itself.
-
rampUpMinimumHostsPct
Get the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.- Returns:
- the rampUpMinimumHostsPct value.
-
withRampUpMinimumHostsPct
Set the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.- Parameters:
rampUpMinimumHostsPct
- the rampUpMinimumHostsPct value to set.- Returns:
- the ScalingSchedule object itself.
-
rampUpCapacityThresholdPct
Get the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.- Returns:
- the rampUpCapacityThresholdPct value.
-
withRampUpCapacityThresholdPct
Set the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.- Parameters:
rampUpCapacityThresholdPct
- the rampUpCapacityThresholdPct value to set.- Returns:
- the ScalingSchedule object itself.
-
peakStartTime
Get the peakStartTime property: Starting time for peak period.- Returns:
- the peakStartTime value.
-
withPeakStartTime
Set the peakStartTime property: Starting time for peak period.- Parameters:
peakStartTime
- the peakStartTime value to set.- Returns:
- the ScalingSchedule object itself.
-
peakLoadBalancingAlgorithm
Get the peakLoadBalancingAlgorithm property: Load balancing algorithm for peak period.- Returns:
- the peakLoadBalancingAlgorithm value.
-
withPeakLoadBalancingAlgorithm
public ScalingSchedule withPeakLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm peakLoadBalancingAlgorithm) Set the peakLoadBalancingAlgorithm property: Load balancing algorithm for peak period.- Parameters:
peakLoadBalancingAlgorithm
- the peakLoadBalancingAlgorithm value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownStartTime
Get the rampDownStartTime property: Starting time for ramp down period.- Returns:
- the rampDownStartTime value.
-
withRampDownStartTime
Set the rampDownStartTime property: Starting time for ramp down period.- Parameters:
rampDownStartTime
- the rampDownStartTime value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownLoadBalancingAlgorithm
Get the rampDownLoadBalancingAlgorithm property: Load balancing algorithm for ramp down period.- Returns:
- the rampDownLoadBalancingAlgorithm value.
-
withRampDownLoadBalancingAlgorithm
public ScalingSchedule withRampDownLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm rampDownLoadBalancingAlgorithm) Set the rampDownLoadBalancingAlgorithm property: Load balancing algorithm for ramp down period.- Parameters:
rampDownLoadBalancingAlgorithm
- the rampDownLoadBalancingAlgorithm value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownMinimumHostsPct
Get the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.- Returns:
- the rampDownMinimumHostsPct value.
-
withRampDownMinimumHostsPct
Set the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.- Parameters:
rampDownMinimumHostsPct
- the rampDownMinimumHostsPct value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownCapacityThresholdPct
Get the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.- Returns:
- the rampDownCapacityThresholdPct value.
-
withRampDownCapacityThresholdPct
Set the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.- Parameters:
rampDownCapacityThresholdPct
- the rampDownCapacityThresholdPct value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownForceLogoffUsers
Get the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.- Returns:
- the rampDownForceLogoffUsers value.
-
withRampDownForceLogoffUsers
Set the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.- Parameters:
rampDownForceLogoffUsers
- the rampDownForceLogoffUsers value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownStopHostsWhen
Get the rampDownStopHostsWhen property: Specifies when to stop hosts during ramp down period.- Returns:
- the rampDownStopHostsWhen value.
-
withRampDownStopHostsWhen
Set the rampDownStopHostsWhen property: Specifies when to stop hosts during ramp down period.- Parameters:
rampDownStopHostsWhen
- the rampDownStopHostsWhen value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownWaitTimeMinutes
Get the rampDownWaitTimeMinutes property: Number of minutes to wait to stop hosts during ramp down period.- Returns:
- the rampDownWaitTimeMinutes value.
-
withRampDownWaitTimeMinutes
Set the rampDownWaitTimeMinutes property: Number of minutes to wait to stop hosts during ramp down period.- Parameters:
rampDownWaitTimeMinutes
- the rampDownWaitTimeMinutes value to set.- Returns:
- the ScalingSchedule object itself.
-
rampDownNotificationMessage
Get the rampDownNotificationMessage property: Notification message for users during ramp down period.- Returns:
- the rampDownNotificationMessage value.
-
withRampDownNotificationMessage
Set the rampDownNotificationMessage property: Notification message for users during ramp down period.- Parameters:
rampDownNotificationMessage
- the rampDownNotificationMessage value to set.- Returns:
- the ScalingSchedule object itself.
-
offPeakStartTime
Get the offPeakStartTime property: Starting time for off-peak period.- Returns:
- the offPeakStartTime value.
-
withOffPeakStartTime
Set the offPeakStartTime property: Starting time for off-peak period.- Parameters:
offPeakStartTime
- the offPeakStartTime value to set.- Returns:
- the ScalingSchedule object itself.
-
offPeakLoadBalancingAlgorithm
Get the offPeakLoadBalancingAlgorithm property: Load balancing algorithm for off-peak period.- Returns:
- the offPeakLoadBalancingAlgorithm value.
-
withOffPeakLoadBalancingAlgorithm
public ScalingSchedule withOffPeakLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm offPeakLoadBalancingAlgorithm) Set the offPeakLoadBalancingAlgorithm property: Load balancing algorithm for off-peak period.- Parameters:
offPeakLoadBalancingAlgorithm
- the offPeakLoadBalancingAlgorithm value to set.- Returns:
- the ScalingSchedule object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-