ClusterUpgradePolicy Class

Package:

com.azure.resourcemanager.servicefabric.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-servicefabric:1.0.0-beta.4

• java.lang.Object
• • com.azure.resourcemanager.servicefabric.models.ClusterUpgradePolicy

public final class ClusterUpgradePolicy

Describes the policy used when upgrading the cluster.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
ClusterUpgradeDeltaHealthPolicy	deltaHealthPolicy() Get the deltaHealthPolicy property: The cluster delta health policy used when upgrading the cluster.
Boolean	forceRestart() Get the forceRestart property: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
String	healthCheckRetryTimeout() Get the healthCheckRetryTimeout property: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back.
String	healthCheckStableDuration() Get the healthCheckStableDuration property: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain.
String	healthCheckWaitDuration() Get the healthCheckWaitDuration property: The length of time to wait after completing an upgrade domain before performing health checks.
ClusterHealthPolicy	healthPolicy() Get the healthPolicy property: The cluster health policy used when upgrading the cluster.
String	upgradeDomainTimeout() Get the upgradeDomainTimeout property: The amount of time each upgrade domain has to complete before the upgrade rolls back.
String	upgradeReplicaSetCheckTimeout() Get the upgradeReplicaSetCheckTimeout property: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues.
String	upgradeTimeout() Get the upgradeTimeout property: The amount of time the overall upgrade has to complete before the upgrade rolls back.
void	validate() Validates the instance.
ClusterUpgradePolicy	withDeltaHealthPolicy(ClusterUpgradeDeltaHealthPolicy deltaHealthPolicy) Set the deltaHealthPolicy property: The cluster delta health policy used when upgrading the cluster.
ClusterUpgradePolicy	withForceRestart(Boolean forceRestart) Set the forceRestart property: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
ClusterUpgradePolicy	withHealthCheckRetryTimeout(String healthCheckRetryTimeout) Set the healthCheckRetryTimeout property: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back.
ClusterUpgradePolicy	withHealthCheckStableDuration(String healthCheckStableDuration) Set the healthCheckStableDuration property: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain.
ClusterUpgradePolicy	withHealthCheckWaitDuration(String healthCheckWaitDuration) Set the healthCheckWaitDuration property: The length of time to wait after completing an upgrade domain before performing health checks.
ClusterUpgradePolicy	withHealthPolicy(ClusterHealthPolicy healthPolicy) Set the healthPolicy property: The cluster health policy used when upgrading the cluster.
ClusterUpgradePolicy	withUpgradeDomainTimeout(String upgradeDomainTimeout) Set the upgradeDomainTimeout property: The amount of time each upgrade domain has to complete before the upgrade rolls back.
ClusterUpgradePolicy	withUpgradeReplicaSetCheckTimeout(String upgradeReplicaSetCheckTimeout) Set the upgradeReplicaSetCheckTimeout property: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues.
ClusterUpgradePolicy	withUpgradeTimeout(String upgradeTimeout) Set the upgradeTimeout property: The amount of time the overall upgrade has to complete before the upgrade rolls back.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClusterUpgradePolicy

public ClusterUpgradePolicy()

Creates an instance of ClusterUpgradePolicy class.

Method Details

deltaHealthPolicy

public ClusterUpgradeDeltaHealthPolicy deltaHealthPolicy()

Get the deltaHealthPolicy property: The cluster delta health policy used when upgrading the cluster.

Returns:

the deltaHealthPolicy value.

forceRestart

public Boolean forceRestart()

Get the forceRestart property: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Returns:

the forceRestart value.

healthCheckRetryTimeout

public String healthCheckRetryTimeout()

Get the healthCheckRetryTimeout property: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Returns:

the healthCheckRetryTimeout value.

healthCheckStableDuration

public String healthCheckStableDuration()

Get the healthCheckStableDuration property: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Returns:

the healthCheckStableDuration value.

healthCheckWaitDuration

public String healthCheckWaitDuration()

Get the healthCheckWaitDuration property: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Returns:

the healthCheckWaitDuration value.

healthPolicy

public ClusterHealthPolicy healthPolicy()

Get the healthPolicy property: The cluster health policy used when upgrading the cluster.

Returns:

the healthPolicy value.

upgradeDomainTimeout

public String upgradeDomainTimeout()

Get the upgradeDomainTimeout property: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Returns:

the upgradeDomainTimeout value.

upgradeReplicaSetCheckTimeout

public String upgradeReplicaSetCheckTimeout()

Get the upgradeReplicaSetCheckTimeout property: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Returns:

the upgradeReplicaSetCheckTimeout value.

upgradeTimeout

public String upgradeTimeout()

Get the upgradeTimeout property: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Returns:

the upgradeTimeout value.

validate

public void validate()

Validates the instance.

withDeltaHealthPolicy

public ClusterUpgradePolicy withDeltaHealthPolicy(ClusterUpgradeDeltaHealthPolicy deltaHealthPolicy)

Set the deltaHealthPolicy property: The cluster delta health policy used when upgrading the cluster.

Parameters:

deltaHealthPolicy - the deltaHealthPolicy value to set.

Returns:

the ClusterUpgradePolicy object itself.

withForceRestart

public ClusterUpgradePolicy withForceRestart(Boolean forceRestart)

Set the forceRestart property: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Parameters:

forceRestart - the forceRestart value to set.

Returns:

the ClusterUpgradePolicy object itself.

withHealthCheckRetryTimeout

public ClusterUpgradePolicy withHealthCheckRetryTimeout(String healthCheckRetryTimeout)

Set the healthCheckRetryTimeout property: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Parameters:

healthCheckRetryTimeout - the healthCheckRetryTimeout value to set.

Returns:

the ClusterUpgradePolicy object itself.

withHealthCheckStableDuration

public ClusterUpgradePolicy withHealthCheckStableDuration(String healthCheckStableDuration)

Set the healthCheckStableDuration property: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Parameters:

healthCheckStableDuration - the healthCheckStableDuration value to set.

Returns:

the ClusterUpgradePolicy object itself.

withHealthCheckWaitDuration

public ClusterUpgradePolicy withHealthCheckWaitDuration(String healthCheckWaitDuration)

Set the healthCheckWaitDuration property: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Parameters:

healthCheckWaitDuration - the healthCheckWaitDuration value to set.

Returns:

the ClusterUpgradePolicy object itself.

withHealthPolicy

public ClusterUpgradePolicy withHealthPolicy(ClusterHealthPolicy healthPolicy)

Set the healthPolicy property: The cluster health policy used when upgrading the cluster.

Parameters:

healthPolicy - the healthPolicy value to set.

Returns:

the ClusterUpgradePolicy object itself.

withUpgradeDomainTimeout

public ClusterUpgradePolicy withUpgradeDomainTimeout(String upgradeDomainTimeout)

Set the upgradeDomainTimeout property: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Parameters:

upgradeDomainTimeout - the upgradeDomainTimeout value to set.

Returns:

the ClusterUpgradePolicy object itself.

withUpgradeReplicaSetCheckTimeout

public ClusterUpgradePolicy withUpgradeReplicaSetCheckTimeout(String upgradeReplicaSetCheckTimeout)

Set the upgradeReplicaSetCheckTimeout property: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Parameters:

upgradeReplicaSetCheckTimeout - the upgradeReplicaSetCheckTimeout value to set.

Returns:

the ClusterUpgradePolicy object itself.

withUpgradeTimeout

public ClusterUpgradePolicy withUpgradeTimeout(String upgradeTimeout)

Set the upgradeTimeout property: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.

Parameters:

upgradeTimeout - the upgradeTimeout value to set.

Returns:

the ClusterUpgradePolicy object itself.