Class: Athenian::FilterCodeChecksRequest

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

Overview

Request body of ‘/filter/code_checks`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilterCodeChecksRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
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
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 89

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

  if attributes.key?(:'triggered_by')
    if (value = attributes[:'triggered_by']).is_a?(Array)
      self.triggered_by = 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?(:'jira')
    self.jira = attributes[:'jira']
  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?(:'account')
    self. = attributes[:'account']
  end

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

Instance Attribute Details

#_in ⇒ Object

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



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

def _in
  @_in
end

#account ⇒ Object

Session account ID.



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

def 
  @account
end

#date_from ⇒ Object

Date from when to start measuring the metrics.



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

def date_from
  @date_from
end

#date_to ⇒ Object

Date until which to measure the metrics.



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

def date_to
  @date_to
end

#jira ⇒ Object

Returns the value of attribute jira.



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

def jira
  @jira
end

#labels_exclude ⇒ Object

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



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

def labels_exclude
  @labels_exclude
end

#labels_include ⇒ Object

At least one of these labels must be present in the checked PRs.



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

def labels_include
  @labels_include
end

#quantiles ⇒ Object

Returns the value of attribute quantiles.



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

def quantiles
  @quantiles
end

#timezone ⇒ Object

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



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

def timezone
  @timezone
end

#triggered_by ⇒ Object

Check runs must be triggered by commits pushed by these people. When it is impossible to determine who pushed, e.g. in legacy API based checks, they are committers. It is possible to mention whole teams using the syntax ‘id` where `id` is a team identifier (see `/teams`).



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

def triggered_by
  @triggered_by
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 45

def self.attribute_map
  {
    :'_in' => :'in',
    :'triggered_by' => :'triggered_by',
    :'labels_include' => :'labels_include',
    :'labels_exclude' => :'labels_exclude',
    :'jira' => :'jira',
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'timezone' => :'timezone',
    :'account' => :'account',
    :'quantiles' => :'quantiles'
  }
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



240
241
242
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 240

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 66

def self.openapi_types
  {
    :'_in' => :'Array<String>',
    :'triggered_by' => :'Array<String>',
    :'labels_include' => :'Array<String>',
    :'labels_exclude' => :'Array<String>',
    :'jira' => :'ForSetCodeChecksJira',
    :'date_from' => :'Date',
    :'date_to' => :'Date',
    :'timezone' => :'Integer',
    :'account' => :'Integer',
    :'quantiles' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _in == o._in &&
      triggered_by == o.triggered_by &&
      labels_include == o.labels_include &&
      labels_exclude == o.labels_exclude &&
      jira == o.jira &&
      date_from == o.date_from &&
      date_to == o.date_to &&
      timezone == o.timezone &&
       == o. &&
      quantiles == o.quantiles
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



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
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 271

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 342

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 247

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 233

def hash
  [_in, triggered_by, labels_include, labels_exclude, jira, date_from, date_to, timezone, , 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



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

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



318
319
320
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 324

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



312
313
314
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 312

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



184
185
186
187
188
189
190
191
192
 
# File 'lib/athenian/models/filter_code_checks_request.rb', line 184

def valid?
  return false if @_in.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 @account.nil?
  true
end