Class: Azure::IotHub::Mgmt::V2018_12_01_preview::Models::EndpointHealthData

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/endpoint_health_data.rb

Overview

The health data for an endpoint

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#endpoint_id ⇒ String

Returns Id of the endpoint.

Returns:

  • (String) —

    Id of the endpoint



16
17
18
 
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/endpoint_health_data.rb', line 16

def endpoint_id
  @endpoint_id
end

#health_status ⇒ EndpointHealthStatus

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. Possible values include: ‘unknown’, ‘healthy’, ‘unhealthy’, ‘dead’

Returns:



31
32
33
 
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/endpoint_health_data.rb', line 31

def health_status
  @health_status
end

Class Method Details

.mapper ⇒ Object

Mapper for EndpointHealthData class as Ruby Hash. This will be used for serialization/deserialization.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/2018-12-01-preview/generated/azure_mgmt_iot_hub/models/endpoint_health_data.rb', line 38

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'EndpointHealthData',
    type: {
      name: 'Composite',
      class_name: 'EndpointHealthData',
      model_properties: {
        endpoint_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'endpointId',
          type: {
            name: 'String'
          }
        },
        health_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'healthStatus',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end