Package com.azure.resourcemanager.iothub.models

Interface EndpointHealthData

public interface EndpointHealthData
An immutable client-side representation of EndpointHealthData.

  • Method Details

    • endpointId

      String endpointId()
      Gets the endpointId property: Id of the endpoint.
      Returns:
      the endpointId value.

    • healthStatus

      EndpointHealthStatus healthStatus()
      Gets the healthStatus property: 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.
      Returns:
      the healthStatus value.

    • lastKnownError

      String lastKnownError()
      Gets the lastKnownError property: Last error obtained when a message failed to be delivered to iot hub.
      Returns:
      the lastKnownError value.

    • lastKnownErrorTime

      OffsetDateTime lastKnownErrorTime()
      Gets the lastKnownErrorTime property: Time at which the last known error occurred.
      Returns:
      the lastKnownErrorTime value.

    • lastSuccessfulSendAttemptTime

      OffsetDateTime lastSuccessfulSendAttemptTime()
      Gets the lastSuccessfulSendAttemptTime property: Last time iot hub successfully sent a message to the endpoint.
      Returns:
      the lastSuccessfulSendAttemptTime value.

    • lastSendAttemptTime

      OffsetDateTime lastSendAttemptTime()
      Gets the lastSendAttemptTime property: Last time iot hub tried to send a message to the endpoint.
      Returns:
      the lastSendAttemptTime value.

    • innerModel

      EndpointHealthDataInner innerModel()
      Gets the inner com.azure.resourcemanager.iothub.fluent.models.EndpointHealthDataInner object.
      Returns:
      the inner object.