ScalingSchedule Class

Package:

com.azure.resourcemanager.desktopvirtualization.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-desktopvirtualization:1.2.0

• java.lang.Object
• • com.azure.resourcemanager.desktopvirtualization.models.ScalingSchedule

Implements

JsonSerializable<ScalingSchedule>

public final class ScalingSchedule
implements JsonSerializable<ScalingSchedule>

A ScalingPlanPooledSchedule.

Constructor Summary

Constructor	Description
ScalingSchedule()	Creates an instance of ScalingSchedule class.

Method Summary

Modifier and Type	Method and Description
List<ScalingScheduleDaysOfWeekItem>	daysOfWeek() Get the daysOfWeek property: Set of days of the week on which this schedule is active.
static ScalingSchedule	fromJson(JsonReader jsonReader) Reads an instance of ScalingSchedule from the JsonReader.
String	name() Get the name property: Name of the ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	offPeakLoadBalancingAlgorithm() Get the offPeakLoadBalancingAlgorithm property: Load balancing algorithm for off-peak period.
Time	offPeakStartTime() Get the offPeakStartTime property: Starting time for off-peak period.
SessionHostLoadBalancingAlgorithm	peakLoadBalancingAlgorithm() Get the peakLoadBalancingAlgorithm property: Load balancing algorithm for peak period.
Time	peakStartTime() Get the peakStartTime property: Starting time for peak period.
Integer	rampDownCapacityThresholdPct() Get the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.
Boolean	rampDownForceLogoffUsers() Get the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.
SessionHostLoadBalancingAlgorithm	rampDownLoadBalancingAlgorithm() Get the rampDownLoadBalancingAlgorithm property: Load balancing algorithm for ramp down period.
Integer	rampDownMinimumHostsPct() Get the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.
String	rampDownNotificationMessage() Get the rampDownNotificationMessage property: Notification message for users during ramp down period.
Time	rampDownStartTime() Get the rampDownStartTime property: Starting time for ramp down period.
StopHostsWhen	rampDownStopHostsWhen() Get the rampDownStopHostsWhen property: Specifies when to stop hosts during ramp down period.
Integer	rampDownWaitTimeMinutes() Get the rampDownWaitTimeMinutes property: Number of minutes to wait to stop hosts during ramp down period.
Integer	rampUpCapacityThresholdPct() Get the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.
SessionHostLoadBalancingAlgorithm	rampUpLoadBalancingAlgorithm() Get the rampUpLoadBalancingAlgorithm property: Load balancing algorithm for ramp up period.
Integer	rampUpMinimumHostsPct() Get the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.
Time	rampUpStartTime() Get the rampUpStartTime property: Starting time for ramp up period.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
ScalingSchedule	withDaysOfWeek(List<ScalingScheduleDaysOfWeekItem> daysOfWeek) Set the daysOfWeek property: Set of days of the week on which this schedule is active.
ScalingSchedule	withName(String name) Set the name property: Name of the ScalingPlanPooledSchedule.
ScalingSchedule	withOffPeakLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm offPeakLoadBalancingAlgorithm) Set the offPeakLoadBalancingAlgorithm property: Load balancing algorithm for off-peak period.
ScalingSchedule	withOffPeakStartTime(Time offPeakStartTime) Set the offPeakStartTime property: Starting time for off-peak period.
ScalingSchedule	withPeakLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm peakLoadBalancingAlgorithm) Set the peakLoadBalancingAlgorithm property: Load balancing algorithm for peak period.
ScalingSchedule	withPeakStartTime(Time peakStartTime) Set the peakStartTime property: Starting time for peak period.
ScalingSchedule	withRampDownCapacityThresholdPct(Integer rampDownCapacityThresholdPct) Set the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.
ScalingSchedule	withRampDownForceLogoffUsers(Boolean rampDownForceLogoffUsers) Set the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.
ScalingSchedule	withRampDownLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm rampDownLoadBalancingAlgorithm) Set the rampDownLoadBalancingAlgorithm property: Load balancing algorithm for ramp down period.
ScalingSchedule	withRampDownMinimumHostsPct(Integer rampDownMinimumHostsPct) Set the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.
ScalingSchedule	withRampDownNotificationMessage(String rampDownNotificationMessage) Set the rampDownNotificationMessage property: Notification message for users during ramp down period.
ScalingSchedule	withRampDownStartTime(Time rampDownStartTime) Set the rampDownStartTime property: Starting time for ramp down period.
ScalingSchedule	withRampDownStopHostsWhen(StopHostsWhen rampDownStopHostsWhen) Set the rampDownStopHostsWhen property: Specifies when to stop hosts during ramp down period.
ScalingSchedule	withRampDownWaitTimeMinutes(Integer rampDownWaitTimeMinutes) Set the rampDownWaitTimeMinutes property: Number of minutes to wait to stop hosts during ramp down period.
ScalingSchedule	withRampUpCapacityThresholdPct(Integer rampUpCapacityThresholdPct) Set the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.
ScalingSchedule	withRampUpLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm rampUpLoadBalancingAlgorithm) Set the rampUpLoadBalancingAlgorithm property: Load balancing algorithm for ramp up period.
ScalingSchedule	withRampUpMinimumHostsPct(Integer rampUpMinimumHostsPct) Set the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.
ScalingSchedule	withRampUpStartTime(Time rampUpStartTime) Set the rampUpStartTime property: Starting time for ramp up period.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ScalingSchedule

public ScalingSchedule()

Creates an instance of ScalingSchedule class.

Method Details

daysOfWeek

public List<ScalingScheduleDaysOfWeekItem> daysOfWeek()

Get the daysOfWeek property: Set of days of the week on which this schedule is active.

Returns:

the daysOfWeek value.

fromJson

public static ScalingSchedule fromJson(JsonReader jsonReader)

Reads an instance of ScalingSchedule from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ScalingSchedule if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ScalingSchedule.

name

public String name()

Get the name property: Name of the ScalingPlanPooledSchedule.

Returns:

the name value.

offPeakLoadBalancingAlgorithm

public SessionHostLoadBalancingAlgorithm offPeakLoadBalancingAlgorithm()

Get the offPeakLoadBalancingAlgorithm property: Load balancing algorithm for off-peak period.

Returns:

the offPeakLoadBalancingAlgorithm value.

offPeakStartTime

public Time offPeakStartTime()

Get the offPeakStartTime property: Starting time for off-peak period.

Returns:

the offPeakStartTime value.

peakLoadBalancingAlgorithm

public SessionHostLoadBalancingAlgorithm peakLoadBalancingAlgorithm()

Get the peakLoadBalancingAlgorithm property: Load balancing algorithm for peak period.

Returns:

the peakLoadBalancingAlgorithm value.

peakStartTime

public Time peakStartTime()

Get the peakStartTime property: Starting time for peak period.

Returns:

the peakStartTime value.

rampDownCapacityThresholdPct

public Integer rampDownCapacityThresholdPct()

Get the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.

Returns:

the rampDownCapacityThresholdPct value.

rampDownForceLogoffUsers

public Boolean rampDownForceLogoffUsers()

Get the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.

Returns:

the rampDownForceLogoffUsers value.

rampDownLoadBalancingAlgorithm

public SessionHostLoadBalancingAlgorithm rampDownLoadBalancingAlgorithm()

Get the rampDownLoadBalancingAlgorithm property: Load balancing algorithm for ramp down period.

Returns:

the rampDownLoadBalancingAlgorithm value.

rampDownMinimumHostsPct

public Integer rampDownMinimumHostsPct()

Get the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.

Returns:

the rampDownMinimumHostsPct value.

rampDownNotificationMessage

public String rampDownNotificationMessage()

Get the rampDownNotificationMessage property: Notification message for users during ramp down period.

Returns:

the rampDownNotificationMessage value.

rampDownStartTime

public Time rampDownStartTime()

Get the rampDownStartTime property: Starting time for ramp down period.

Returns:

the rampDownStartTime value.

rampDownStopHostsWhen

public StopHostsWhen rampDownStopHostsWhen()

Get the rampDownStopHostsWhen property: Specifies when to stop hosts during ramp down period.

Returns:

the rampDownStopHostsWhen value.

rampDownWaitTimeMinutes

public Integer rampDownWaitTimeMinutes()

Get the rampDownWaitTimeMinutes property: Number of minutes to wait to stop hosts during ramp down period.

Returns:

the rampDownWaitTimeMinutes value.

rampUpCapacityThresholdPct

public Integer rampUpCapacityThresholdPct()

Get the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.

Returns:

the rampUpCapacityThresholdPct value.

rampUpLoadBalancingAlgorithm

public SessionHostLoadBalancingAlgorithm rampUpLoadBalancingAlgorithm()

Get the rampUpLoadBalancingAlgorithm property: Load balancing algorithm for ramp up period.

Returns:

the rampUpLoadBalancingAlgorithm value.

rampUpMinimumHostsPct

public Integer rampUpMinimumHostsPct()

Get the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.

Returns:

the rampUpMinimumHostsPct value.

rampUpStartTime

public Time rampUpStartTime()

Get the rampUpStartTime property: Starting time for ramp up period.

Returns:

the rampUpStartTime value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withDaysOfWeek

public ScalingSchedule withDaysOfWeek(List<ScalingScheduleDaysOfWeekItem> daysOfWeek)

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.

withName

public ScalingSchedule withName(String name)

Set the name property: Name of the ScalingPlanPooledSchedule.

Parameters:

name - the name value to set.

Returns:

the ScalingSchedule object itself.

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.

withOffPeakStartTime

public ScalingSchedule withOffPeakStartTime(Time offPeakStartTime)

Set the offPeakStartTime property: Starting time for off-peak period.

Parameters:

offPeakStartTime - the offPeakStartTime value to set.

Returns:

the ScalingSchedule object itself.

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.

withPeakStartTime

public ScalingSchedule withPeakStartTime(Time peakStartTime)

Set the peakStartTime property: Starting time for peak period.

Parameters:

peakStartTime - the peakStartTime value to set.

Returns:

the ScalingSchedule object itself.

withRampDownCapacityThresholdPct

public ScalingSchedule withRampDownCapacityThresholdPct(Integer rampDownCapacityThresholdPct)

Set the rampDownCapacityThresholdPct property: Capacity threshold for ramp down period.

Parameters:

rampDownCapacityThresholdPct - the rampDownCapacityThresholdPct value to set.

Returns:

the ScalingSchedule object itself.

withRampDownForceLogoffUsers

public ScalingSchedule withRampDownForceLogoffUsers(Boolean rampDownForceLogoffUsers)

Set the rampDownForceLogoffUsers property: Should users be logged off forcefully from hosts.

Parameters:

rampDownForceLogoffUsers - the rampDownForceLogoffUsers value to set.

Returns:

the ScalingSchedule object itself.

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.

withRampDownMinimumHostsPct

public ScalingSchedule withRampDownMinimumHostsPct(Integer rampDownMinimumHostsPct)

Set the rampDownMinimumHostsPct property: Minimum host percentage for ramp down period.

Parameters:

rampDownMinimumHostsPct - the rampDownMinimumHostsPct value to set.

Returns:

the ScalingSchedule object itself.

withRampDownNotificationMessage

public ScalingSchedule withRampDownNotificationMessage(String rampDownNotificationMessage)

Set the rampDownNotificationMessage property: Notification message for users during ramp down period.

Parameters:

rampDownNotificationMessage - the rampDownNotificationMessage value to set.

Returns:

the ScalingSchedule object itself.

withRampDownStartTime

public ScalingSchedule withRampDownStartTime(Time rampDownStartTime)

Set the rampDownStartTime property: Starting time for ramp down period.

Parameters:

rampDownStartTime - the rampDownStartTime value to set.

Returns:

the ScalingSchedule object itself.

withRampDownStopHostsWhen

public ScalingSchedule withRampDownStopHostsWhen(StopHostsWhen rampDownStopHostsWhen)

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.

withRampDownWaitTimeMinutes

public ScalingSchedule withRampDownWaitTimeMinutes(Integer rampDownWaitTimeMinutes)

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.

withRampUpCapacityThresholdPct

public ScalingSchedule withRampUpCapacityThresholdPct(Integer rampUpCapacityThresholdPct)

Set the rampUpCapacityThresholdPct property: Capacity threshold for ramp up period.

Parameters:

rampUpCapacityThresholdPct - the rampUpCapacityThresholdPct value to set.

Returns:

the ScalingSchedule object itself.

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.

withRampUpMinimumHostsPct

public ScalingSchedule withRampUpMinimumHostsPct(Integer rampUpMinimumHostsPct)

Set the rampUpMinimumHostsPct property: Minimum host percentage for ramp up period.

Parameters:

rampUpMinimumHostsPct - the rampUpMinimumHostsPct value to set.

Returns:

the ScalingSchedule object itself.

withRampUpStartTime

public ScalingSchedule withRampUpStartTime(Time rampUpStartTime)

Set the rampUpStartTime property: Starting time for ramp up period.

Parameters:

rampUpStartTime - the rampUpStartTime value to set.

Returns:

the ScalingSchedule object itself.