Class: Azure::ServiceFabric::V6_4_0_36::Models::HealthInformation

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb

Overview

Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.

Direct Known Subclasses

HealthEvent

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#description ⇒ String

represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker “[Truncated]”, and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.

Returns:

  • (String) —

    The description of the health information. It



67
68
69
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 67

def description
  @description
end

#health_state ⇒ HealthState

as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’

Returns:

  • (HealthState) —

    The health state of a Service Fabric entity such



41
42
43
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 41

def health_state
  @health_state
end

#property ⇒ String

have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId “LocalWatchdog” can monitor the state of the available disk on a node, so it can report “AvailableDisk” property on that node. The same reporter can monitor the node connectivity, so it can report a property “Connectivity” on the same node. In the health store, these reports are treated as separate health events for the specified node.

Together with the SourceId, the property uniquely identifies the health information.

Returns:

  • (String) —

    The property of the health information. An entity can



36
37
38
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 36

def property
  @property
end

#remove_when_expired ⇒ Boolean

from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can’t report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.

Returns:

  • (Boolean) —

    Value that indicates whether the report is removed



88
89
90
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 88

def remove_when_expired
  @remove_when_expired
end

#sequence_number ⇒ String

numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.

Returns:

  • (String) —

    The sequence number for this health report as a



75
76
77
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 75

def sequence_number
  @sequence_number
end

#source_id ⇒ String

client/watchdog/system component that generated the health information.

Returns:

  • (String) —

    The source name that identifies the



19
20
21
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 19

def source_id
  @source_id
end

#time_to_live_in_milli_seconds ⇒ Duration

This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.

If not specified, time to live defaults to infinite value.

Returns:

  • (Duration) —

    The duration for which this health report is valid.



55
56
57
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 55

def time_to_live_in_milli_seconds
  @time_to_live_in_milli_seconds
end

Class Method Details

.mapper ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/health_information.rb', line 95

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'HealthInformation',
    type: {
      name: 'Composite',
      class_name: 'HealthInformation',
      model_properties: {
        source_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'SourceId',
          type: {
            name: 'String'
          }
        },
        property: {
          client_side_validation: true,
          required: true,
          serialized_name: 'Property',
          type: {
            name: 'String'
          }
        },
        health_state: {
          client_side_validation: true,
          required: true,
          serialized_name: 'HealthState',
          type: {
            name: 'String'
          }
        },
        time_to_live_in_milli_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'TimeToLiveInMilliSeconds',
          type: {
            name: 'TimeSpan'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Description',
          type: {
            name: 'String'
          }
        },
        sequence_number: {
          client_side_validation: true,
          required: false,
          serialized_name: 'SequenceNumber',
          type: {
            name: 'String'
          }
        },
        remove_when_expired: {
          client_side_validation: true,
          required: false,
          serialized_name: 'RemoveWhenExpired',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end