Class: Athenian::JIRAHistogramsRequest

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

Overview

Request of ‘/histograms/jira`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JIRAHistogramsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Session account ID.



55
56
57
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 55

def 
  @account
end

#date_from ⇒ Object

Date from when to start measuring the distribution.



40
41
42
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 40

def date_from
  @date_from
end

#date_to ⇒ Object

Date until which to measure the distribution.



43
44
45
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 43

def date_to
  @date_to
end

#epics ⇒ Object

Returns the value of attribute epics.



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

def epics
  @epics
end

#exclude_inactive ⇒ Object

Value indicating whether issues with the last update older than ‘date_from` should be ignored.



49
50
51
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 49

def exclude_inactive
  @exclude_inactive
end

#histograms ⇒ Object

Histogram parameters for each wanted topic.



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

def histograms
  @histograms
end

#labels_exclude ⇒ Object

PRs cannot relate to JIRA issue labels from the list.



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

def labels_exclude
  @labels_exclude
end

#labels_include ⇒ Object

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



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

def labels_include
  @labels_include
end

#priorities ⇒ Object

Selected issue priorities.



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

def priorities
  @priorities
end

#projects ⇒ Object

Issues must belong to these JIRA projects.



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

def projects
  @projects
end

#quantiles ⇒ Object

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



52
53
54
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 52

def quantiles
  @quantiles
end

#timezone ⇒ Object

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



46
47
48
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 46

def timezone
  @timezone
end

#types ⇒ Object

Selected issue types.



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

def types
  @types
end

#with ⇒ Object

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



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

def with
  @with
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 58

def self.attribute_map
  {
    :'priorities' => :'priorities',
    :'types' => :'types',
    :'epics' => :'epics',
    :'labels_include' => :'labels_include',
    :'labels_exclude' => :'labels_exclude',
    :'with' => :'with',
    :'projects' => :'projects',
    :'histograms' => :'histograms',
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'timezone' => :'timezone',
    :'exclude_inactive' => :'exclude_inactive',
    :'quantiles' => :'quantiles',
    :'account' => :'account'
  }
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/jira_histograms_request.rb', line 320

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 83

def self.openapi_types
  {
    :'priorities' => :'Array<String>',
    :'types' => :'Array<String>',
    :'epics' => :'Array<JIRAEpic>',
    :'labels_include' => :'Array<String>',
    :'labels_exclude' => :'Array<String>',
    :'with' => :'Array<JIRAFilterWith>',
    :'projects' => :'Array<String>',
    :'histograms' => :'Array<JIRAHistogramDefinition>',
    :'date_from' => :'Date',
    :'date_to' => :'Date',
    :'timezone' => :'Integer',
    :'exclude_inactive' => :'Boolean',
    :'quantiles' => :'Array<Float>',
    :'account' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      priorities == o.priorities &&
      types == o.types &&
      epics == o.epics &&
      labels_include == o.labels_include &&
      labels_exclude == o.labels_exclude &&
      with == o.with &&
      projects == o.projects &&
      histograms == o.histograms &&
      date_from == o.date_from &&
      date_to == o.date_to &&
      timezone == o.timezone &&
      exclude_inactive == o.exclude_inactive &&
      quantiles == o.quantiles &&
       == o.
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/jira_histograms_request.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/jira_histograms_request.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/jira_histograms_request.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/jira_histograms_request.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/jira_histograms_request.rb', line 313

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



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
232
233
234
235
236
237
238
239
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 200

def list_invalid_properties
  invalid_properties = Array.new
  if @histograms.nil?
    invalid_properties.push('invalid value for "histograms", histograms 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 !@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 @account.nil?
    invalid_properties.push('invalid value for "account", account 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/jira_histograms_request.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/jira_histograms_request.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/jira_histograms_request.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



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/athenian/models/jira_histograms_request.rb', line 243

def valid?
  return false if @histograms.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 !@quantiles.nil? && @quantiles.length > 2
  return false if !@quantiles.nil? && @quantiles.length < 2
  return false if @account.nil?
  true
end