com.azure.resourcemanager.iothub.models.EndpointHealthStatus.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus"
fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus"
name: "EndpointHealthStatus"
nameWithType: "EndpointHealthStatus"
summary: "Health statuses have following meanings."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **EndpointHealthStatus**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.EndpointHealthStatus()"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.EndpointHealthStatus()"
  name: "EndpointHealthStatus()"
  nameWithType: "EndpointHealthStatus.EndpointHealthStatus()"
  summary: "Creates a new instance of Endpoint<wbr>Health<wbr>Status value."
  deprecatedTag: "Use the <xref uid=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
  syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public EndpointHealthStatus()"
  desc: "Creates a new instance of EndpointHealthStatus value."
  hasDeprecatedTag: true
fields:
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.DEAD"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.DEAD"
  name: "DEAD"
  nameWithType: "EndpointHealthStatus.DEAD"
  summary: "Static value dead for Endpoint<wbr>Health<wbr>Status."
  modifiers:
  - "static"
  - "final"
  field:
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static final EndpointHealthStatus DEAD"
  desc: "Static value dead for EndpointHealthStatus."
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.DEGRADED"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.DEGRADED"
  name: "DEGRADED"
  nameWithType: "EndpointHealthStatus.DEGRADED"
  summary: "Static value degraded for Endpoint<wbr>Health<wbr>Status."
  modifiers:
  - "static"
  - "final"
  field:
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static final EndpointHealthStatus DEGRADED"
  desc: "Static value degraded for EndpointHealthStatus."
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.HEALTHY"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.HEALTHY"
  name: "HEALTHY"
  nameWithType: "EndpointHealthStatus.HEALTHY"
  summary: "Static value healthy for Endpoint<wbr>Health<wbr>Status."
  modifiers:
  - "static"
  - "final"
  field:
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static final EndpointHealthStatus HEALTHY"
  desc: "Static value healthy for EndpointHealthStatus."
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.UNHEALTHY"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.UNHEALTHY"
  name: "UNHEALTHY"
  nameWithType: "EndpointHealthStatus.UNHEALTHY"
  summary: "Static value unhealthy for Endpoint<wbr>Health<wbr>Status."
  modifiers:
  - "static"
  - "final"
  field:
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static final EndpointHealthStatus UNHEALTHY"
  desc: "Static value unhealthy for EndpointHealthStatus."
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.UNKNOWN"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.UNKNOWN"
  name: "UNKNOWN"
  nameWithType: "EndpointHealthStatus.UNKNOWN"
  summary: "Static value unknown for Endpoint<wbr>Health<wbr>Status."
  modifiers:
  - "static"
  - "final"
  field:
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static final EndpointHealthStatus UNKNOWN"
  desc: "Static value unknown for EndpointHealthStatus."
methods:
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.fromString(java.lang.String)"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.fromString(String name)"
  name: "fromString(String name)"
  nameWithType: "EndpointHealthStatus.fromString(String name)"
  summary: "Creates or finds a Endpoint<wbr>Health<wbr>Status from its string representation."
  modifiers:
  - "static"
  parameters:
  - description: "a name to look for."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public static EndpointHealthStatus fromString(String name)"
  desc: "Creates or finds a EndpointHealthStatus from its string representation."
  returns:
    description: "the corresponding EndpointHealthStatus."
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.values()"
  fullName: "com.azure.resourcemanager.iothub.models.EndpointHealthStatus.values()"
  name: "values()"
  nameWithType: "EndpointHealthStatus.values()"
  summary: "Gets known Endpoint<wbr>Health<wbr>Status values."
  modifiers:
  - "static"
  syntax: "public static Collection<EndpointHealthStatus> values()"
  desc: "Gets known EndpointHealthStatus values."
  returns:
    description: "known EndpointHealthStatus values."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a>&lt;<xref href=\"com.azure.resourcemanager.iothub.models.EndpointHealthStatus?alt=com.azure.resourcemanager.iothub.models.EndpointHealthStatus&text=EndpointHealthStatus\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "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."
metadata: {}
package: "com.azure.resourcemanager.iothub.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0