Class: Athenian::ForSetDeployments

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

Overview

Filters for ‘/metrics/deployments`. Nothing is strictly required. Achieve the best performance by packing all your filters in a single `ForSetDeployments` instead of sending multiple `ForSetDeployments`-s. For example, use `repogroups` and `withgroups` to request separate metrics for several repository sets and teams.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ForSetDeployments

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#envgroups ⇒ Object

List of environment groups for which to calculate the metrics.



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

def envgroups
  @envgroups
end

#environments ⇒ Object

List of environments for which to calculate the metrics. We calculate the metrics for each environment independently.



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

def environments
  @environments
end

#jira ⇒ Object

Returns the value of attribute jira.



33
34
35
 
# File 'lib/athenian/models/for_set_deployments.rb', line 33

def jira
  @jira
end

#pr_labels_exclude ⇒ Object

None of these labels must be present in each deployed PR.



31
32
33
 
# File 'lib/athenian/models/for_set_deployments.rb', line 31

def pr_labels_exclude
  @pr_labels_exclude
end

#pr_labels_include ⇒ Object

At least one of these labels must be present in at least one deployed PR.



28
29
30
 
# File 'lib/athenian/models/for_set_deployments.rb', line 28

def pr_labels_include
  @pr_labels_include
end

#repogroups ⇒ Object

Lists of indexes in ‘repositories` or `developers` that define independent groups that must be processed individually. The groups may have intersections.



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

def repogroups
  @repogroups
end

#repositories ⇒ Object

Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.



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

def repositories
  @repositories
end

#with ⇒ Object

Returns the value of attribute with.



22
23
24
 
# File 'lib/athenian/models/for_set_deployments.rb', line 22

def with
  @with
end

#with_labels ⇒ Object

Deployments should contain at least one of the specified label values. ‘null` matches any label value and effectively checks the label existence.



36
37
38
 
# File 'lib/athenian/models/for_set_deployments.rb', line 36

def with_labels
  @with_labels
end

#withgroups ⇒ Object

Alternative to ‘with` - calculate metrics for distinct filters separately.



25
26
27
 
# File 'lib/athenian/models/for_set_deployments.rb', line 25

def withgroups
  @withgroups
end

#without_labels ⇒ Object

Deployments may not contain the specified label values. ‘null` matches any label value and effectively ensures that the label does not exist.



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

def without_labels
  @without_labels
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/athenian/models/for_set_deployments.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/athenian/models/for_set_deployments.rb', line 48

def self.attribute_map
  {
    :'repositories' => :'repositories',
    :'repogroups' => :'repogroups',
    :'with' => :'with',
    :'withgroups' => :'withgroups',
    :'pr_labels_include' => :'pr_labels_include',
    :'pr_labels_exclude' => :'pr_labels_exclude',
    :'jira' => :'jira',
    :'with_labels' => :'with_labels',
    :'without_labels' => :'without_labels',
    :'environments' => :'environments',
    :'envgroups' => :'envgroups'
  }
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



227
228
229
 
# File 'lib/athenian/models/for_set_deployments.rb', line 227

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'repositories' => :'Array<String>',
    :'repogroups' => :'Array<Array<Integer>>',
    :'with' => :'DeploymentWith',
    :'withgroups' => :'Array<DeploymentWith>',
    :'pr_labels_include' => :'Array<String>',
    :'pr_labels_exclude' => :'Array<String>',
    :'jira' => :'JIRAFilter',
    :'with_labels' => :'Object',
    :'without_labels' => :'Object',
    :'environments' => :'Array<String>',
    :'envgroups' => :'Array<Array<String>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/athenian/models/for_set_deployments.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      repositories == o.repositories &&
      repogroups == o.repogroups &&
      with == o.with &&
      withgroups == o.withgroups &&
      pr_labels_include == o.pr_labels_include &&
      pr_labels_exclude == o.pr_labels_exclude &&
      jira == o.jira &&
      with_labels == o.with_labels &&
      without_labels == o.without_labels &&
      environments == o.environments &&
      envgroups == o.envgroups
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



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
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/athenian/models/for_set_deployments.rb', line 258

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/athenian/models/for_set_deployments.rb', line 329

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/athenian/models/for_set_deployments.rb', line 234

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


214
215
216
 
# File 'lib/athenian/models/for_set_deployments.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/athenian/models/for_set_deployments.rb', line 220

def hash
  [repositories, repogroups, with, withgroups, pr_labels_include, pr_labels_exclude, jira, with_labels, without_labels, environments, envgroups].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



168
169
170
171
172
173
174
175
 
# File 'lib/athenian/models/for_set_deployments.rb', line 168

def list_invalid_properties
  invalid_properties = Array.new
  if !@repogroups.nil? && @repogroups.length < 1
    invalid_properties.push('invalid value for "repogroups", number of items must be greater than or equal to 1.')
  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



305
306
307
 
# File 'lib/athenian/models/for_set_deployments.rb', line 305

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/athenian/models/for_set_deployments.rb', line 311

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



299
300
301
 
# File 'lib/athenian/models/for_set_deployments.rb', line 299

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



179
180
181
182
 
# File 'lib/athenian/models/for_set_deployments.rb', line 179

def valid?
  return false if !@repogroups.nil? && @repogroups.length < 1
  true
end