UpgradePolicy Class

Package:

com.azure.compute.batch.models

Maven Artifact:

com.azure:azure-compute-batch:1.0.0-beta.5

• java.lang.Object
• • com.azure.compute.batch.models.UpgradePolicy

Implements

JsonSerializable<UpgradePolicy>

public final class UpgradePolicy
implements JsonSerializable<UpgradePolicy>

Describes an upgrade policy - automatic, manual, or rolling.

Constructor Summary

Constructor	Description
UpgradePolicy(UpgradeMode mode)	Creates an instance of UpgradePolicy class.

Method Summary

Modifier and Type	Method and Description
static UpgradePolicy	fromJson(JsonReader jsonReader) Reads an instance of UpgradePolicy from the JsonReader.
AutomaticOsUpgradePolicy	getAutomaticOsUpgradePolicy() Get the automaticOsUpgradePolicy property: Configuration parameters used for performing automatic OS Upgrade.
UpgradeMode	getMode() Get the mode property: Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: **Manual** - You control the application of updates to virtual machines in the scale set.
RollingUpgradePolicy	getRollingUpgradePolicy() Get the rollingUpgradePolicy property: The configuration parameters used while performing a rolling upgrade.
UpgradePolicy	setAutomaticOsUpgradePolicy(AutomaticOsUpgradePolicy automaticOsUpgradePolicy) Set the automaticOsUpgradePolicy property: Configuration parameters used for performing automatic OS Upgrade.
UpgradePolicy	setRollingUpgradePolicy(RollingUpgradePolicy rollingUpgradePolicy) Set the rollingUpgradePolicy property: The configuration parameters used while performing a rolling upgrade.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

UpgradePolicy

public UpgradePolicy(UpgradeMode mode)

Creates an instance of UpgradePolicy class.

Parameters:

mode - the mode value to set.

Method Details

fromJson

public static UpgradePolicy fromJson(JsonReader jsonReader)

Reads an instance of UpgradePolicy from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getAutomaticOsUpgradePolicy

public AutomaticOsUpgradePolicy getAutomaticOsUpgradePolicy()

Get the automaticOsUpgradePolicy property: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade.

Returns:

the automaticOsUpgradePolicy value.

getMode

public UpgradeMode getMode()

Get the mode property: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.

Returns:

the mode value.

getRollingUpgradePolicy

public RollingUpgradePolicy getRollingUpgradePolicy()

Get the rollingUpgradePolicy property: The configuration parameters used while performing a rolling upgrade.

Returns:

the rollingUpgradePolicy value.

setAutomaticOsUpgradePolicy

public UpgradePolicy setAutomaticOsUpgradePolicy(AutomaticOsUpgradePolicy automaticOsUpgradePolicy)

Set the automaticOsUpgradePolicy property: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade.

Parameters:

automaticOsUpgradePolicy - the automaticOsUpgradePolicy value to set.

Returns:

the UpgradePolicy object itself.

setRollingUpgradePolicy

public UpgradePolicy setRollingUpgradePolicy(RollingUpgradePolicy rollingUpgradePolicy)

Set the rollingUpgradePolicy property: The configuration parameters used while performing a rolling upgrade.

Parameters:

rollingUpgradePolicy - the rollingUpgradePolicy value to set.

Returns:

the UpgradePolicy object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException