ClusterHealthPolicy 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.ClusterHealthPolicy

public final class ClusterHealthPolicy

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String,ApplicationHealthPolicy>	applicationHealthPolicies() Get the applicationHealthPolicies property: Defines the application health policy map used to evaluate the health of an application or one of its children entities.
Integer	maxPercentUnhealthyApplications() Get the maxPercentUnhealthyApplications property: The maximum allowed percentage of unhealthy applications before reporting an error.
Integer	maxPercentUnhealthyNodes() Get the maxPercentUnhealthyNodes property: The maximum allowed percentage of unhealthy nodes before reporting an error.
void	validate() Validates the instance.
ClusterHealthPolicy	withApplicationHealthPolicies(Map<String,ApplicationHealthPolicy> applicationHealthPolicies) Set the applicationHealthPolicies property: Defines the application health policy map used to evaluate the health of an application or one of its children entities.
ClusterHealthPolicy	withMaxPercentUnhealthyApplications(Integer maxPercentUnhealthyApplications) Set the maxPercentUnhealthyApplications property: The maximum allowed percentage of unhealthy applications before reporting an error.
ClusterHealthPolicy	withMaxPercentUnhealthyNodes(Integer maxPercentUnhealthyNodes) Set the maxPercentUnhealthyNodes property: The maximum allowed percentage of unhealthy nodes before reporting an error.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClusterHealthPolicy

public ClusterHealthPolicy()

Creates an instance of ClusterHealthPolicy class.

Method Details

applicationHealthPolicies

public Map applicationHealthPolicies()

Get the applicationHealthPolicies property: Defines the application health policy map used to evaluate the health of an application or one of its children entities.

Returns:

the applicationHealthPolicies value.

maxPercentUnhealthyApplications

public Integer maxPercentUnhealthyApplications()

Get the maxPercentUnhealthyApplications property: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

Returns:

the maxPercentUnhealthyApplications value.

maxPercentUnhealthyNodes

public Integer maxPercentUnhealthyNodes()

Get the maxPercentUnhealthyNodes property: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

Returns:

the maxPercentUnhealthyNodes value.

validate

public void validate()

Validates the instance.

withApplicationHealthPolicies

public ClusterHealthPolicy withApplicationHealthPolicies(Map applicationHealthPolicies)

Set the applicationHealthPolicies property: Defines the application health policy map used to evaluate the health of an application or one of its children entities.

Parameters:

applicationHealthPolicies - the applicationHealthPolicies value to set.

Returns:

the ClusterHealthPolicy object itself.

withMaxPercentUnhealthyApplications

public ClusterHealthPolicy withMaxPercentUnhealthyApplications(Integer maxPercentUnhealthyApplications)

Set the maxPercentUnhealthyApplications property: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.

Parameters:

maxPercentUnhealthyApplications - the maxPercentUnhealthyApplications value to set.

Returns:

the ClusterHealthPolicy object itself.

withMaxPercentUnhealthyNodes

public ClusterHealthPolicy withMaxPercentUnhealthyNodes(Integer maxPercentUnhealthyNodes)

Set the maxPercentUnhealthyNodes property: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.

Parameters:

maxPercentUnhealthyNodes - the maxPercentUnhealthyNodes value to set.

Returns:

the ClusterHealthPolicy object itself.