Share via

UpgradeOverrideSettings Class

  • Reference
Package:
com.azure.resourcemanager.containerservice.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-containerservice:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.containerservice.models.UpgradeOverrideSettings

Implements

JsonSerializable<UpgradeOverrideSettings>

public final class UpgradeOverrideSettings
implements JsonSerializable<UpgradeOverrideSettings>

Settings for overrides when upgrading a cluster.

Constructor Summary

Constructor Description
UpgradeOverrideSettings()

Creates an instance of UpgradeOverrideSettings class.

Method Summary

Modifier and Type Method and Description
Boolean forceUpgrade()

Get the forceUpgrade property: Whether to force upgrade the cluster.
static UpgradeOverrideSettings fromJson(JsonReader jsonReader)

Reads an instance of UpgradeOverrideSettings from the JsonReader.
JsonWriter toJson(JsonWriter jsonWriter)
OffsetDateTime until()

Get the until property: Until when the overrides are effective.
void validate()

Validates the instance.
UpgradeOverrideSettings withForceUpgrade(Boolean forceUpgrade)

Set the forceUpgrade property: Whether to force upgrade the cluster.
UpgradeOverrideSettings withUntil(OffsetDateTime until)

Set the until property: Until when the overrides are effective.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

UpgradeOverrideSettings

public UpgradeOverrideSettings()

Creates an instance of UpgradeOverrideSettings class.

Method Details

forceUpgrade

public Boolean forceUpgrade()

Get the forceUpgrade property: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution.

Returns:

the forceUpgrade value.

fromJson

public static UpgradeOverrideSettings fromJson(JsonReader jsonReader)

Reads an instance of UpgradeOverrideSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of UpgradeOverrideSettings 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 UpgradeOverrideSettings.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

until

public OffsetDateTime until()

Get the until property: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect.

Returns:

the until value.

validate

public void validate()

Validates the instance.

withForceUpgrade

public UpgradeOverrideSettings withForceUpgrade(Boolean forceUpgrade)

Set the forceUpgrade property: Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution.

Parameters:

forceUpgrade - the forceUpgrade value to set.

Returns:

the UpgradeOverrideSettings object itself.

withUntil

public UpgradeOverrideSettings withUntil(OffsetDateTime until)

Set the until property: Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect.

Parameters:

until - the until value to set.

Returns:

the UpgradeOverrideSettings object itself.

Applies to