Class: Azure::ServiceFabric::V6_2_0_9::Models::HealthEvent

Inherits:
HealthInformation show all
Includes:
MsRestAzure
Defined in:
lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb

Overview

Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.

Instance Attribute Summary collapse

Attributes inherited from HealthInformation

#description, #health_state, #property, #remove_when_expired, #sequence_number, #source_id, #time_to_live_in_milli_seconds

Class Method Summary collapse

Instance Attribute Details

#is_expired ⇒ Boolean

otherwise false.

Returns:

  • (Boolean) —

    Returns true if the health event is expired,



19
20
21
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb', line 19

def is_expired
  @is_expired
end

#last_error_transition_at ⇒ DateTime

property returns the time at which the health report was first reported with ‘Error’. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ‘Error’ health report was received.

If the current health state is ‘Ok’ or ‘Warning’, returns the date and time at which the health state was last in ‘Error’, before transitioning to a different state.

If the health state was never ‘Error’, the value will be zero date-time.

Returns:

  • (DateTime) —

    If the current health state is ‘Error’, this



70
71
72
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb', line 70

def last_error_transition_at
  @last_error_transition_at
end

#last_modified_utc_timestamp ⇒ DateTime

modified by the health store.

Returns:

  • (DateTime) —

    The date and time when the health report was last



27
28
29
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb', line 27

def last_modified_utc_timestamp
  @last_modified_utc_timestamp
end

#last_ok_transition_at ⇒ DateTime

returns the time at which the health report was first reported with ‘Ok’. For periodic reporting, many reports with the same state may have been generated. This property returns the date and time when the first ‘Ok’ health report was received.

If the current health state is ‘Error’ or ‘Warning’, returns the date and time at which the health state was last in ‘Ok’, before transitioning to a different state.

If the health state was never ‘Ok’, the value will be zero date-time.

Returns:

  • (DateTime) —

    If the current health state is ‘Ok’, this property



42
43
44
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb', line 42

def last_ok_transition_at
  @last_ok_transition_at
end

#last_warning_transition_at ⇒ DateTime

property returns the time at which the health report was first reported with ‘Warning’. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ‘Warning’ health report was received.

If the current health state is ‘Ok’ or ‘Error’, returns the date and time at which the health state was last in ‘Warning’, before transitioning to a different state.

If the health state was never ‘Warning’, the value will be zero date-time.

Returns:

  • (DateTime) —

    If the current health state is ‘Warning’, this



56
57
58
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb', line 56

def last_warning_transition_at
  @last_warning_transition_at
end

#source_utc_timestamp ⇒ DateTime

the source.

Returns:

  • (DateTime) —

    The date and time when the health report was sent by



23
24
25
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb', line 23

def source_utc_timestamp
  @source_utc_timestamp
end

Class Method Details

.mapper ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/health_event.rb', line 77

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'HealthEvent',
    type: {
      name: 'Composite',
      class_name: 'HealthEvent',
      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'
          }
        },
        is_expired: {
          client_side_validation: true,
          required: false,
          serialized_name: 'IsExpired',
          type: {
            name: 'Boolean'
          }
        },
        source_utc_timestamp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'SourceUtcTimestamp',
          type: {
            name: 'DateTime'
          }
        },
        last_modified_utc_timestamp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'LastModifiedUtcTimestamp',
          type: {
            name: 'DateTime'
          }
        },
        last_ok_transition_at: {
          client_side_validation: true,
          required: false,
          serialized_name: 'LastOkTransitionAt',
          type: {
            name: 'DateTime'
          }
        },
        last_warning_transition_at: {
          client_side_validation: true,
          required: false,
          serialized_name: 'LastWarningTransitionAt',
          type: {
            name: 'DateTime'
          }
        },
        last_error_transition_at: {
          client_side_validation: true,
          required: false,
          serialized_name: 'LastErrorTransitionAt',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end