Class: LinodeOpenapiClient::AddedGetNotifications200DataInner

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb

Overview

An important, often time-sensitive item related to your Account.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddedGetNotifications200DataInner

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 106

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

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

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.key?(:'entity')
    self.entity = attributes[:'entity']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  end

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

  if attributes.key?(:'_when')
    self._when = attributes[:'_when']
  end

  if attributes.key?(:'severity')
    self.severity = attributes[:'severity']
  end

  if attributes.key?(:'_until')
    self._until = attributes[:'_until']
  end
end

Instance Attribute Details

#_until ⇒ Object

Read-only If this Notification has a duration, this will be the ending time for the Event/action. For example, if there is scheduled maintenance for one of our systems, ‘until` would be set to the end of the maintenance window.



40
41
42
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 40

def _until
  @_until
end

#_when ⇒ Object

Read-only If this Notification is of an Event that will happen at a fixed, future time, this is when the named action will be taken. For example, if a Linode is to be migrated in response to a Security Advisory, this field will contain the approximate time the Linode will be taken offline for migration.



34
35
36
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 34

def _when
  @_when
end

#body ⇒ Object

Read-only A full description of this Notification, in markdown format. Not all Notifications include bodies.



28
29
30
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 28

def body
  @body
end

#entity ⇒ Object

Returns the value of attribute entity.



22
23
24
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 22

def entity
  @entity
end

#label ⇒ Object

Read-only A short description of this Notification.



20
21
22
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 20

def label
  @label
end

#message ⇒ Object

Read-only A human-readable description of the Notification.



31
32
33
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 31

def message
  @message
end

#severity ⇒ Object

Read-only The severity of this Notification. This field can be used to decide how prominently to display the Notification, what color to make the display text, etc.



37
38
39
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 37

def severity
  @severity
end

#type ⇒ Object

Read-only The type of Notification this is.



25
26
27
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 25

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 245

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 65

def self.attribute_map
  {
    :'label' => :'label',
    :'entity' => :'entity',
    :'type' => :'type',
    :'body' => :'body',
    :'message' => :'message',
    :'_when' => :'when',
    :'severity' => :'severity',
    :'_until' => :'until'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 221

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



98
99
100
101
102
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 98

def self.openapi_nullable
  Set.new([
    :'body',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 84

def self.openapi_types
  {
    :'label' => :'String',
    :'entity' => :'AddedGetNotifications200DataInnerEntity',
    :'type' => :'String',
    :'body' => :'String',
    :'message' => :'String',
    :'_when' => :'Time',
    :'severity' => :'String',
    :'_until' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label == o.label &&
      entity == o.entity &&
      type == o.type &&
      body == o.body &&
      message == o.message &&
      _when == o._when &&
      severity == o.severity &&
      _until == o._until
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 316

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


208
209
210
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 214

def hash
  [label, entity, type, body, message, _when, severity, _until].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



154
155
156
157
158
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 154

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



292
293
294
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 292

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 298

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



286
287
288
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 286

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



162
163
164
165
166
167
168
169
 
# File 'lib/linode_openapi_client/models/added_get_notifications200_data_inner.rb', line 162

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["migration_scheduled", "migration_imminent", "migration_pending", "reboot_scheduled", "outage", "payment_due", "ticket_important", "ticket_abuse", "notice", "maintenance", "promotion"])
  return false unless type_validator.valid?(@type)
  severity_validator = EnumAttributeValidator.new('String', ["minor", "major", "critical"])
  return false unless severity_validator.valid?(@severity)
  true
end