Class: Athenian::FilteredDeployment

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/models/filtered_deployment.rb

Overview

Everything we know about the deployment.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilteredDeployment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/athenian/models/filtered_deployment.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Returns the value of attribute code.



39
40
41
 
# File 'lib/athenian/models/filtered_deployment.rb', line 39

def code
  @code
end

#components ⇒ Object

List of deployed software version. Each item identifies a Git reference in a repository, either a tag or a commit hash.



17
18
19
 
# File 'lib/athenian/models/filtered_deployment.rb', line 17

def components
  @components
end

#conclusion ⇒ Object

Returns the value of attribute conclusion.



34
35
36
 
# File 'lib/athenian/models/filtered_deployment.rb', line 34

def conclusion
  @conclusion
end

#date_finished ⇒ Object

Timestamp of when the deployment procedure completed.



32
33
34
 
# File 'lib/athenian/models/filtered_deployment.rb', line 32

def date_finished
  @date_finished
end

#date_started ⇒ Object

Timestamp of when the deployment procedure launched.



29
30
31
 
# File 'lib/athenian/models/filtered_deployment.rb', line 29

def date_started
  @date_started
end

#environment ⇒ Object

Name of the environment where the deployment happened.



20
21
22
 
# File 'lib/athenian/models/filtered_deployment.rb', line 20

def environment
  @environment
end

#labels ⇒ Object

Arbitrary key-value metadata that associates with the deployment.



37
38
39
 
# File 'lib/athenian/models/filtered_deployment.rb', line 37

def labels
  @labels
end

#name ⇒ Object

Name of the deployment. If is not specified, we generate our own by the template ‘<environment shortcut>-<date>-<hash of the components>`. The value may not contain \n - new line character, and ’ - single quote.



23
24
25
 
# File 'lib/athenian/models/filtered_deployment.rb', line 23

def name
  @name
end

#prs ⇒ Object

List of deployed pull requests.



42
43
44
 
# File 'lib/athenian/models/filtered_deployment.rb', line 42

def prs
  @prs
end

#releases ⇒ Object

Deployed releases. The format matches ‘FilteredRelease` except that `prs` is the number of released pull requests instead of a list.



45
46
47
 
# File 'lib/athenian/models/filtered_deployment.rb', line 45

def releases
  @releases
end

#url ⇒ Object

URL pointing at the internal details of the deployment.



26
27
28
 
# File 'lib/athenian/models/filtered_deployment.rb', line 26

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/athenian/models/filtered_deployment.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/athenian/models/filtered_deployment.rb', line 70

def self.attribute_map
  {
    :'components' => :'components',
    :'environment' => :'environment',
    :'name' => :'name',
    :'url' => :'url',
    :'date_started' => :'date_started',
    :'date_finished' => :'date_finished',
    :'conclusion' => :'conclusion',
    :'labels' => :'labels',
    :'code' => :'code',
    :'prs' => :'prs',
    :'releases' => :'releases'
  }
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



320
321
322
 
# File 'lib/athenian/models/filtered_deployment.rb', line 320

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



116
117
118
119
120
121
 
# File 'lib/athenian/models/filtered_deployment.rb', line 116

def self.openapi_all_of
  [
  :'DeploymentAnalysis',
  :'DeploymentNotification'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
113
 
# File 'lib/athenian/models/filtered_deployment.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/athenian/models/filtered_deployment.rb', line 92

def self.openapi_types
  {
    :'components' => :'Array<DeployedComponent>',
    :'environment' => :'String',
    :'name' => :'String',
    :'url' => :'String',
    :'date_started' => :'Time',
    :'date_finished' => :'Time',
    :'conclusion' => :'DeploymentConclusion',
    :'labels' => :'Object',
    :'code' => :'DeploymentAnalysisCode',
    :'prs' => :'Array<DeployedPullRequest>',
    :'releases' => :'Array<DeployedRelease>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/athenian/models/filtered_deployment.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      components == o.components &&
      environment == o.environment &&
      name == o.name &&
      url == o.url &&
      date_started == o.date_started &&
      date_finished == o.date_finished &&
      conclusion == o.conclusion &&
      labels == o.labels &&
      code == o.code &&
      prs == o.prs &&
      releases == o.releases
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



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
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/athenian/models/filtered_deployment.rb', line 351

def _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 = Athenian.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/athenian/models/filtered_deployment.rb', line 422

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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/athenian/models/filtered_deployment.rb', line 327

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


307
308
309
 
# File 'lib/athenian/models/filtered_deployment.rb', line 307

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



313
314
315
 
# File 'lib/athenian/models/filtered_deployment.rb', line 313

def hash
  [components, environment, name, url, date_started, date_finished, conclusion, labels, code, prs, releases].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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/athenian/models/filtered_deployment.rb', line 191

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

  if @components.length < 1
    invalid_properties.push('invalid value for "components", number of items must be greater than or equal to 1.')
  end

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

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

  pattern = Regexp.new(/^([^'\s]| ){1,100}$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

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

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

  if @code.nil?
    invalid_properties.push('invalid value for "code", code 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



398
399
400
 
# File 'lib/athenian/models/filtered_deployment.rb', line 398

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



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/athenian/models/filtered_deployment.rb', line 404

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



392
393
394
 
# File 'lib/athenian/models/filtered_deployment.rb', line 392

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



235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/athenian/models/filtered_deployment.rb', line 235

def valid?
  return false if @components.nil?
  return false if @components.length < 1
  return false if @environment.nil?
  return false if @environment.to_s.length < 1
  return false if !@name.nil? && @name !~ Regexp.new(/^([^'\s]| ){1,100}$/)
  return false if @date_started.nil?
  return false if @date_finished.nil?
  return false if @conclusion.nil?
  return false if @code.nil?
  true
end