Class: Athenian::JIRAMetricsRequest

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

Overview

Request body of ‘/metrics/jira`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JIRAMetricsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
188
189
190
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
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_for ⇒ Object

Calculate metrics separately for each JIRA Filter in the list. Not compatible with other jira filters in the request: ‘priorities`, `types`, `labels_include`, `labels_exclude`, `epics`, `projects`.



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

def _for
  @_for
end

#account ⇒ Object

Session account ID.



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

def 
  @account
end

#date_from ⇒ Object

Issues must be resolved after this date.



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

def date_from
  @date_from
end

#date_to ⇒ Object

Issues must be created before this date.



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

def date_to
  @date_to
end

#epics ⇒ Object

JIRA issues must be attached to any of the epic IDs from this list.



47
48
49
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 47

def epics
  @epics
end

#exclude_inactive ⇒ Object

Value indicating whether issues with the last update older than ‘date_from` should be ignored. If `date_from` and `date_to` are `null`, does nothing.



44
45
46
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 44

def exclude_inactive
  @exclude_inactive
end

#granularities ⇒ Object

The splits of the specified time range.



62
63
64
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 62

def granularities
  @granularities
end

#group_by_jira_label ⇒ Object

Value indicating whether the metrics should be grouped by assigned JIRA issue label.



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

def group_by_jira_label
  @group_by_jira_label
end

#labels_exclude ⇒ Object

JIRA issues may not contain labels from this list.



41
42
43
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 41

def labels_exclude
  @labels_exclude
end

#labels_include ⇒ Object

JIRA issues must contain at least one label from the list. Several labels may be concatenated by a comma ‘,` so that all of them are required.



38
39
40
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 38

def labels_include
  @labels_include
end

#metrics ⇒ Object

List of measured metrics.



56
57
58
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 56

def metrics
  @metrics
end

#priorities ⇒ Object

Selected issue priorities.



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

def priorities
  @priorities
end

#projects ⇒ Object

Issues must belong to these JIRA projects.



53
54
55
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 53

def projects
  @projects
end

#quantiles ⇒ Object

Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting.



59
60
61
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 59

def quantiles
  @quantiles
end

#timezone ⇒ Object

Local time zone offset in minutes, used to adjust ‘date_from` and `date_to`.



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

def timezone
  @timezone
end

#types ⇒ Object

Selected issue types.



35
36
37
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 35

def types
  @types
end

#with ⇒ Object

Groups of issue participants. The metrics will be calculated for each group.



50
51
52
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 50

def with
  @with
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 68

def self.attribute_map
  {
    :'account' => :'account',
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'_for' => :'for',
    :'timezone' => :'timezone',
    :'priorities' => :'priorities',
    :'types' => :'types',
    :'labels_include' => :'labels_include',
    :'labels_exclude' => :'labels_exclude',
    :'exclude_inactive' => :'exclude_inactive',
    :'epics' => :'epics',
    :'with' => :'with',
    :'projects' => :'projects',
    :'metrics' => :'metrics',
    :'quantiles' => :'quantiles',
    :'granularities' => :'granularities',
    :'group_by_jira_label' => :'group_by_jira_label'
  }
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



379
380
381
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 379

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 96

def self.openapi_types
  {
    :'account' => :'Integer',
    :'date_from' => :'Date',
    :'date_to' => :'Date',
    :'_for' => :'Array<JIRAFilter>',
    :'timezone' => :'Integer',
    :'priorities' => :'Array<String>',
    :'types' => :'Array<String>',
    :'labels_include' => :'Array<String>',
    :'labels_exclude' => :'Array<String>',
    :'exclude_inactive' => :'Boolean',
    :'epics' => :'Array<String>',
    :'with' => :'Array<JIRAFilterWith>',
    :'projects' => :'Array<String>',
    :'metrics' => :'Array<JIRAMetricID>',
    :'quantiles' => :'Array<Float>',
    :'granularities' => :'Array<String>',
    :'group_by_jira_label' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      date_from == o.date_from &&
      date_to == o.date_to &&
      _for == o._for &&
      timezone == o.timezone &&
      priorities == o.priorities &&
      types == o.types &&
      labels_include == o.labels_include &&
      labels_exclude == o.labels_exclude &&
      exclude_inactive == o.exclude_inactive &&
      epics == o.epics &&
      with == o.with &&
      projects == o.projects &&
      metrics == o.metrics &&
      quantiles == o.quantiles &&
      granularities == o.granularities &&
      group_by_jira_label == o.group_by_jira_label
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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 410

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



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 481

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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 386

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


366
367
368
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 366

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



372
373
374
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 372

def hash
  [, date_from, date_to, _for, timezone, priorities, types, labels_include, labels_exclude, exclude_inactive, epics, with, projects, metrics, quantiles, granularities, group_by_jira_label].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



232
233
234
235
236
237
238
239
240
241
242
243
244
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
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 232

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

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

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

  if !@timezone.nil? && @timezone > 780
    invalid_properties.push('invalid value for "timezone", must be smaller than or equal to 780.')
  end

  if !@timezone.nil? && @timezone < -720
    invalid_properties.push('invalid value for "timezone", must be greater than or equal to -720.')
  end

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

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

  if !@quantiles.nil? && @quantiles.length > 2
    invalid_properties.push('invalid value for "quantiles", number of items must be less than or equal to 2.')
  end

  if !@quantiles.nil? && @quantiles.length < 2
    invalid_properties.push('invalid value for "quantiles", number of items must be greater than or equal to 2.')
  end

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

  if @granularities.length < 1
    invalid_properties.push('invalid value for "granularities", 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



457
458
459
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 457

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



463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 463

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



451
452
453
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 451

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/athenian/models/jira_metrics_request.rb', line 283

def valid?
  return false if @account.nil?
  return false if @date_from.nil?
  return false if @date_to.nil?
  return false if !@timezone.nil? && @timezone > 780
  return false if !@timezone.nil? && @timezone < -720
  return false if @exclude_inactive.nil?
  return false if @metrics.nil?
  return false if !@quantiles.nil? && @quantiles.length > 2
  return false if !@quantiles.nil? && @quantiles.length < 2
  return false if @granularities.nil?
  return false if @granularities.length < 1
  true
end