Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AutoPR] iothub/resource-manager #2347

Closed
wants to merge 7 commits into from
Prev Previous commit
Generated from 7311fd41d1714f152d4569e6641c8821a0273ae4 (#2992)
changes to improve documentation of endpoint health statuses for routing
  • Loading branch information
AutorestCI authored Feb 28, 2019
commit 61cbf28bee34c2445604de9442ba8a1380e25dea
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,18 @@ public class EndpointHealthDataInner {
private String endpointId;

/**
* Health status. Possible values include: 'unknown', 'healthy',
* 'unhealthy', 'dead'.
* Health statuses have following meanings. The 'healthy' status shows that
* the endpoint is accepting messages as expected. The 'unhealthy' status
* shows that the endpoint is not accepting messages as expected and IoT
* Hub is retrying to send data to this endpoint. The status of an
* unhealthy endpoint will be updated to healthy when IoT Hub has
* established an eventually consistent state of health. The 'dead' status
* shows that the endpoint is not accepting messages, after IoT Hub retried
* sending messages for the retrial period. See IoT Hub metrics to identify
* errors and monitor issues with endpoints. The 'unknown' status shows
* that the IoT Hub has not established a connection with the endpoint. No
* messages have been delivered to or rejected from this endpoint. Possible
* values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
*/
@JsonProperty(value = "healthStatus")
private EndpointHealthStatus healthStatus;
Expand All @@ -49,7 +59,7 @@ public EndpointHealthDataInner withEndpointId(String endpointId) {
}

/**
* Get health status. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
* Get health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
*
* @return the healthStatus value
*/
Expand All @@ -58,7 +68,7 @@ public EndpointHealthStatus healthStatus() {
}

/**
* Set health status. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
* Set health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
*
* @param healthStatus the healthStatus value to set
* @return the EndpointHealthDataInner object itself.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,18 @@ public class EndpointHealthDataInner {
private String endpointId;

/**
* Health status. Possible values include: 'unknown', 'healthy',
* 'unhealthy', 'dead'.
* Health statuses have following meanings. The 'healthy' status shows that
* the endpoint is accepting messages as expected. The 'unhealthy' status
* shows that the endpoint is not accepting messages as expected and IoT
* Hub is retrying to send data to this endpoint. The status of an
* unhealthy endpoint will be updated to healthy when IoT Hub has
* established an eventually consistent state of health. The 'dead' status
* shows that the endpoint is not accepting messages, after IoT Hub retried
* sending messages for the retrial period. See IoT Hub metrics to identify
* errors and monitor issues with endpoints. The 'unknown' status shows
* that the IoT Hub has not established a connection with the endpoint. No
* messages have been delivered to or rejected from this endpoint. Possible
* values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
*/
@JsonProperty(value = "healthStatus")
private EndpointHealthStatus healthStatus;
Expand All @@ -49,7 +59,7 @@ public EndpointHealthDataInner withEndpointId(String endpointId) {
}

/**
* Get health status. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
* Get health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
*
* @return the healthStatus value
*/
Expand All @@ -58,7 +68,7 @@ public EndpointHealthStatus healthStatus() {
}

/**
* Set health status. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
* Set health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead'.
*
* @param healthStatus the healthStatus value to set
* @return the EndpointHealthDataInner object itself.
Expand Down