Class: Athenian::FilterDeploymentsRequest

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

Overview

Filters to select the deployments in ‘/filter/deployments`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilterDeploymentsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 104

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

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

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

Instance Attribute Details

#_in ⇒ Object

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



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

def _in
  @_in
end

#account ⇒ Object

Session account ID.



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

def 
  @account
end

#conclusions ⇒ Object

Deployments must execute with any of these conclusions.



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

def conclusions
  @conclusions
end

#date_from ⇒ Object

Search for the deployments since this date.



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

def date_from
  @date_from
end

#date_to ⇒ Object

Search for the deployments until this date.



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

def date_to
  @date_to
end

#environments ⇒ Object

Deployments must belong to one of these environments.



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

def environments
  @environments
end

#jira ⇒ Object

Returns the value of attribute jira.



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

def jira
  @jira
end

#pr_labels_exclude ⇒ Object

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



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

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.



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

def pr_labels_include
  @pr_labels_include
end

#timezone ⇒ Object

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



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

def timezone
  @timezone
end

#with ⇒ Object

Returns the value of attribute with.



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

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.



48
49
50
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 48

def with_labels
  @with_labels
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.



51
52
53
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 51

def without_labels
  @without_labels
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 54

def self.attribute_map
  {
    :'date_from' => :'date_from',
    :'date_to' => :'date_to',
    :'timezone' => :'timezone',
    :'account' => :'account',
    :'_in' => :'in',
    :'with' => :'with',
    :'pr_labels_include' => :'pr_labels_include',
    :'pr_labels_exclude' => :'pr_labels_exclude',
    :'jira' => :'jira',
    :'environments' => :'environments',
    :'conclusions' => :'conclusions',
    :'with_labels' => :'with_labels',
    :'without_labels' => :'without_labels'
  }
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



267
268
269
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 267

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 78

def self.openapi_types
  {
    :'date_from' => :'Date',
    :'date_to' => :'Date',
    :'timezone' => :'Integer',
    :'account' => :'Integer',
    :'_in' => :'Array<String>',
    :'with' => :'DeploymentWith',
    :'pr_labels_include' => :'Array<String>',
    :'pr_labels_exclude' => :'Array<String>',
    :'jira' => :'JIRAFilter',
    :'environments' => :'Array<String>',
    :'conclusions' => :'Array<DeploymentConclusion>',
    :'with_labels' => :'Object',
    :'without_labels' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_from == o.date_from &&
      date_to == o.date_to &&
      timezone == o.timezone &&
       == o. &&
      _in == o._in &&
      with == o.with &&
      pr_labels_include == o.pr_labels_include &&
      pr_labels_exclude == o.pr_labels_exclude &&
      jira == o.jira &&
      environments == o.environments &&
      conclusions == o.conclusions &&
      with_labels == o.with_labels &&
      without_labels == o.without_labels
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 298

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 369

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 274

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


254
255
256
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 260

def hash
  [date_from, date_to, timezone, , _in, with, pr_labels_include, pr_labels_exclude, jira, environments, conclusions, with_labels, without_labels].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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 182

def list_invalid_properties
  invalid_properties = Array.new
  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



345
346
347
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 345

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 351

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



339
340
341
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 339

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



209
210
211
212
213
214
215
216
 
# File 'lib/athenian/models/filter_deployments_request.rb', line 209

def valid?
  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