Package com.azure.resourcemanager.iothub.fluent.models

Class EndpointHealthDataInner

  • public final class EndpointHealthDataInner
extends Object
    The health data for an endpoint.

    • Constructor Detail

      • EndpointHealthDataInner

        public EndpointHealthDataInner()

    • Method Detail

      • endpointId

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

      • withEndpointId

        public EndpointHealthDataInner withEndpointId​(String endpointId)
        Set the endpointId property: Id of the endpoint.
        Parameters:
        endpointId - the endpointId value to set.
        Returns:
        the EndpointHealthDataInner object itself.

      • healthStatus

        public EndpointHealthStatus healthStatus()
        Get 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.

      • withHealthStatus

        public EndpointHealthDataInner withHealthStatus​(EndpointHealthStatus healthStatus)
        Set 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.
        Parameters:
        healthStatus - the healthStatus value to set.
        Returns:
        the EndpointHealthDataInner object itself.

      • lastKnownError

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

      • withLastKnownError

        public EndpointHealthDataInner withLastKnownError​(String lastKnownError)
        Set the lastKnownError property: Last error obtained when a message failed to be delivered to iot hub.
        Parameters:
        lastKnownError - the lastKnownError value to set.
        Returns:
        the EndpointHealthDataInner object itself.

      • lastKnownErrorTime

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

      • withLastKnownErrorTime

        public EndpointHealthDataInner withLastKnownErrorTime​(OffsetDateTime lastKnownErrorTime)
        Set the lastKnownErrorTime property: Time at which the last known error occurred.
        Parameters:
        lastKnownErrorTime - the lastKnownErrorTime value to set.
        Returns:
        the EndpointHealthDataInner object itself.

      • lastSuccessfulSendAttemptTime

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

      • withLastSuccessfulSendAttemptTime

        public EndpointHealthDataInner withLastSuccessfulSendAttemptTime​(OffsetDateTime lastSuccessfulSendAttemptTime)
        Set the lastSuccessfulSendAttemptTime property: Last time iot hub successfully sent a message to the endpoint.
        Parameters:
        lastSuccessfulSendAttemptTime - the lastSuccessfulSendAttemptTime value to set.
        Returns:
        the EndpointHealthDataInner object itself.

      • lastSendAttemptTime

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

      • withLastSendAttemptTime

        public EndpointHealthDataInner withLastSendAttemptTime​(OffsetDateTime lastSendAttemptTime)
        Set the lastSendAttemptTime property: Last time iot hub tried to send a message to the endpoint.
        Parameters:
        lastSendAttemptTime - the lastSendAttemptTime value to set.
        Returns:
        the EndpointHealthDataInner object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.