Class: Devdraft::HealthResponseDto

Inherits:
ApiModelBase show all
Defined in:
lib/devdraft/models/health_response_dto.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ HealthResponseDto

Initializes the object



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
 
# File 'lib/devdraft/models/health_response_dto.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Devdraft::HealthResponseDto` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Devdraft::HealthResponseDto`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'timestamp')
    self.timestamp = attributes[:'timestamp']
  else
    self.timestamp = nil
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  else
    self.version = nil
  end

  if attributes.key?(:'database')
    self.database = attributes[:'database']
  else
    self.database = nil
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  else
    self.message = nil
  end

  if attributes.key?(:'authenticated')
    self.authenticated = attributes[:'authenticated']
  else
    self.authenticated = nil
  end
end

Instance Attribute Details

#authenticated ⇒ Object

Indicates whether the request was properly authenticated. Always true for this endpoint since authentication is required.



34
35
36
 
# File 'lib/devdraft/models/health_response_dto.rb', line 34

def authenticated
  @authenticated
end

#database ⇒ Object

Database connectivity status. Shows "connected" when database is accessible, "error" when connection fails.



28
29
30
 
# File 'lib/devdraft/models/health_response_dto.rb', line 28

def database
  @database
end

#message ⇒ Object

Human-readable message describing the current health status and any issues.



31
32
33
 
# File 'lib/devdraft/models/health_response_dto.rb', line 31

def message
  @message
end

#status ⇒ Object

Overall health status of the service. Returns "ok" when healthy, "error" when issues detected.



19
20
21
 
# File 'lib/devdraft/models/health_response_dto.rb', line 19

def status
  @status
end

#timestamp ⇒ Object

ISO 8601 timestamp when the health check was performed.



22
23
24
 
# File 'lib/devdraft/models/health_response_dto.rb', line 22

def timestamp
  @timestamp
end

#version ⇒ Object

Current version of the API service. Useful for debugging and compatibility checks.



25
26
27
 
# File 'lib/devdraft/models/health_response_dto.rb', line 25

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



71
72
73
 
# File 'lib/devdraft/models/health_response_dto.rb', line 71

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/devdraft/models/health_response_dto.rb', line 76

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/devdraft/models/health_response_dto.rb', line 59

def self.attribute_map
  {
    :'status' => :'status',
    :'timestamp' => :'timestamp',
    :'version' => :'version',
    :'database' => :'database',
    :'message' => :'message',
    :'authenticated' => :'authenticated'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/devdraft/models/health_response_dto.rb', line 288

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/devdraft/models/health_response_dto.rb', line 93

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/devdraft/models/health_response_dto.rb', line 81

def self.openapi_types
  {
    :'status' => :'String',
    :'timestamp' => :'Time',
    :'version' => :'String',
    :'database' => :'String',
    :'message' => :'String',
    :'authenticated' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



262
263
264
265
266
267
268
269
270
271
 
# File 'lib/devdraft/models/health_response_dto.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      timestamp == o.timestamp &&
      version == o.version &&
      database == o.database &&
      message == o.message &&
      authenticated == o.authenticated
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


275
276
277
 
# File 'lib/devdraft/models/health_response_dto.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



281
282
283
 
# File 'lib/devdraft/models/health_response_dto.rb', line 281

def hash
  [status, timestamp, version, database, message, authenticated].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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
 
# File 'lib/devdraft/models/health_response_dto.rb', line 153

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @timestamp.nil?
    invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
  end

  if @version.nil?
    invalid_properties.push('invalid value for "version", version cannot be nil.')
  end

  if @database.nil?
    invalid_properties.push('invalid value for "database", database cannot be nil.')
  end

  if @message.nil?
    invalid_properties.push('invalid value for "message", message cannot be nil.')
  end

  if @authenticated.nil?
    invalid_properties.push('invalid value for "authenticated", authenticated cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/devdraft/models/health_response_dto.rb', line 310

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/devdraft/models/health_response_dto.rb', line 185

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["ok", "error"])
  return false unless status_validator.valid?(@status)
  return false if @timestamp.nil?
  return false if @version.nil?
  return false if @database.nil?
  database_validator = EnumAttributeValidator.new('String', ["connected", "error"])
  return false unless database_validator.valid?(@database)
  return false if @message.nil?
  return false if @authenticated.nil?
  true
end