Class: DependencyTracker::NotificationRule

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/models/notification_rule.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NotificationRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DependencyTracker::NotificationRule` 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 `DependencyTracker::NotificationRule`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

  if attributes.key?(:'projects')
    if (value = attributes[:'projects']).is_a?(Array)
      self.projects = value
    end
  end

  if attributes.key?(:'notify_on')
    if (value = attributes[:'notify_on']).is_a?(Array)
      self.notify_on = value
    end
  end

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

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

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

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

Instance Attribute Details

#enabled ⇒ Object

Returns the value of attribute enabled.



19
20
21
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 19

def enabled
  @enabled
end

#message ⇒ Object

Returns the value of attribute message.



29
30
31
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 29

def message
  @message
end

#name ⇒ Object

Returns the value of attribute name.



17
18
19
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 17

def name
  @name
end

#notification_level ⇒ Object

Returns the value of attribute notification_level.



23
24
25
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 23

def notification_level
  @notification_level
end

#notify_on ⇒ Object

Returns the value of attribute notify_on.



27
28
29
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 27

def notify_on
  @notify_on
end

#projects ⇒ Object

Returns the value of attribute projects.



25
26
27
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 25

def projects
  @projects
end

#publisher ⇒ Object

Returns the value of attribute publisher.



31
32
33
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 31

def publisher
  @publisher
end

#publisher_config ⇒ Object

Returns the value of attribute publisher_config.



33
34
35
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 33

def publisher_config
  @publisher_config
end

#scope ⇒ Object

Returns the value of attribute scope.



21
22
23
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 21

def scope
  @scope
end

#uuid ⇒ Object

Returns the value of attribute uuid.



35
36
37
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 35

def uuid
  @uuid
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 60

def self.attribute_map
  {
    :'name' => :'name',
    :'enabled' => :'enabled',
    :'scope' => :'scope',
    :'notification_level' => :'notificationLevel',
    :'projects' => :'projects',
    :'notify_on' => :'notifyOn',
    :'message' => :'message',
    :'publisher' => :'publisher',
    :'publisher_config' => :'publisherConfig',
    :'uuid' => :'uuid'
  }
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



315
316
317
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 315

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 76

def self.openapi_types
  {
    :'name' => :'String',
    :'enabled' => :'Boolean',
    :'scope' => :'String',
    :'notification_level' => :'String',
    :'projects' => :'Array<Project>',
    :'notify_on' => :'Array<String>',
    :'message' => :'String',
    :'publisher' => :'NotificationPublisher',
    :'publisher_config' => :'String',
    :'uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      enabled == o.enabled &&
      scope == o.scope &&
      notification_level == o.notification_level &&
      projects == o.projects &&
      notify_on == o.notify_on &&
      message == o.message &&
      publisher == o.publisher &&
      publisher_config == o.publisher_config &&
      uuid == o.uuid
end

#_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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 343

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    DependencyTracker.const_get(type).build_from_hash(value)
  end
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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 412

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

#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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 322

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


302
303
304
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 308

def hash
  [name, enabled, scope, notification_level, projects, notify_on, message, publisher, publisher_config, uuid].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



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
194
195
196
197
198
199
200
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 159

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

  if !@message.nil? && @message.to_s.length > 1024
    invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 1024.')
  end

  if !@message.nil? && @message.to_s.length < 0
    invalid_properties.push('invalid value for "message", the character length must be great than or equal to 0.')
  end

  pattern = Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  if !@message.nil? && @message !~ pattern
    invalid_properties.push("invalid value for \"message\", must conform to the pattern #{pattern}.")
  end

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

  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



388
389
390
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 388

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 394

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



382
383
384
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 382

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/dependency-tracker-client/models/notification_rule.rb', line 204

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @name.to_s.length < 1
  return false if @name !~ Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  return false if @scope.nil?
  scope_validator = EnumAttributeValidator.new('String', ["SYSTEM", "PORTFOLIO"])
  return false unless scope_validator.valid?(@scope)
  notification_level_validator = EnumAttributeValidator.new('String', ["INFORMATIONAL", "WARNING", "ERROR"])
  return false unless notification_level_validator.valid?(@notification_level)
  return false if !@message.nil? && @message.to_s.length > 1024
  return false if !@message.nil? && @message.to_s.length < 0
  return false if !@message.nil? && @message !~ Regexp.new(/^[\p{White_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$/)
  return false if @uuid.nil?
  true
end