Package com.azure.resourcemanager.iothub.models

Class EndpointHealthStatus

java.lang.Object

com.azure.core.util.ExpandableStringEnum<EndpointHealthStatus>

com.azure.resourcemanager.iothub.models.EndpointHealthStatus

public final class EndpointHealthStatus
extends com.azure.core.util.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

Fields

Modifier and Type	Field	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

Constructors

Constructor	Description
EndpointHealthStatus()

Method Summary

Modifier and Type	Method	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 class com.azure.core.util.ExpandableStringEnum

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

UNKNOWN

public static final EndpointHealthStatus UNKNOWN

Static value unknown for EndpointHealthStatus.

HEALTHY

public static final EndpointHealthStatus HEALTHY

Static value healthy for EndpointHealthStatus.

DEGRADED

public static final EndpointHealthStatus DEGRADED

Static value degraded for EndpointHealthStatus.

UNHEALTHY

public static final EndpointHealthStatus UNHEALTHY

Static value unhealthy for EndpointHealthStatus.

DEAD

public static final EndpointHealthStatus DEAD

Static value dead for EndpointHealthStatus.

Constructor Details

EndpointHealthStatus

public EndpointHealthStatus()

Method Details

fromString

public static EndpointHealthStatus fromString(String name)

Creates or finds a EndpointHealthStatus from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding EndpointHealthStatus.

values

public static Collection<EndpointHealthStatus> values()

Gets known EndpointHealthStatus values.

Returns:

known EndpointHealthStatus values.