EndpointHealthStatus Class

Reference

Package:: com.azure.resourcemanager.iothub.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0

java.lang.Object
- com.azure.core.util.ExpandableStringEnum<T>
- - com.azure.resourcemanager.iothub.models.EndpointHealthStatus

public final class EndpointHealthStatus
extends ExpandableStringEnum<EndpointHealthStatus>

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.

Field Summary

Modifier and Type	Field and Description
static final EndpointHealthStatus	DEAD Static value dead for EndpointHealthStatus.
static final EndpointHealthStatus	DEGRADED Static value degraded for EndpointHealthStatus.
static final EndpointHealthStatus	HEALTHY Static value healthy for EndpointHealthStatus.
static final EndpointHealthStatus	UNHEALTHY Static value unhealthy for EndpointHealthStatus.
static final EndpointHealthStatus	UNKNOWN Static value unknown for EndpointHealthStatus.

Constructor Summary

Constructor	Description
EndpointHealthStatus()	Deprecated Use the fromString(String name) factory method. Creates a new instance of EndpointHealthStatus value.

Constructor

Description

EndpointHealthStatus()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of EndpointHealthStatus value.

Method Summary

Modifier and Type	Method and Description
static EndpointHealthStatus	fromString(String name) Creates or finds a EndpointHealthStatus from its string representation.
static Collection<EndpointHealthStatus>	values() Gets known EndpointHealthStatus values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

DEAD

public static final EndpointHealthStatus DEAD

Static value dead for EndpointHealthStatus.

DEGRADED

public static final EndpointHealthStatus DEGRADED

Static value degraded for EndpointHealthStatus.

HEALTHY

public static final EndpointHealthStatus HEALTHY

Static value healthy for EndpointHealthStatus.

UNHEALTHY

public static final EndpointHealthStatus UNHEALTHY

Static value unhealthy for EndpointHealthStatus.

UNKNOWN

public static final EndpointHealthStatus UNKNOWN

Static value unknown for EndpointHealthStatus.

Constructor Details