Class: Athenian::JIRAIssueType

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

Overview

Details about a JIRA issue type.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JIRAIssueType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
87
88
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
 
# File 'lib/athenian/models/jira_issue_type.rb', line 76

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

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

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

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

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

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

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

Instance Attribute Details

#count ⇒ Object

Number of issues that satisfy the filters and belong to this type.



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

def count
  @count
end

#image ⇒ Object

Icon URL.



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

def image
  @image
end

#is_epic ⇒ Object

Value indicating whether this issue type refers to an epic.



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

def is_epic
  @is_epic
end

#is_subtask ⇒ Object

Value indicating whether this issue type refers to a sub-task.



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

def is_subtask
  @is_subtask
end

#name ⇒ Object

Name of the issue type.



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

def name
  @name
end

#normalized_name ⇒ Object

Normalized name of the issue type. For example, "Sub-tásks" becomes "subtask".



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

def normalized_name
  @normalized_name
end

#project ⇒ Object

Bound project identifier.



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

def project
  @project
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/athenian/models/jira_issue_type.rb', line 38

def self.attribute_map
  {
    :'name' => :'name',
    :'normalized_name' => :'normalized_name',
    :'count' => :'count',
    :'image' => :'image',
    :'project' => :'project',
    :'is_subtask' => :'is_subtask',
    :'is_epic' => :'is_epic'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
 
# File 'lib/athenian/models/jira_issue_type.rb', line 69

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/athenian/models/jira_issue_type.rb', line 56

def self.openapi_types
  {
    :'name' => :'String',
    :'normalized_name' => :'String',
    :'count' => :'Integer',
    :'image' => :'String',
    :'project' => :'String',
    :'is_subtask' => :'Boolean',
    :'is_epic' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/athenian/models/jira_issue_type.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      normalized_name == o.normalized_name &&
      count == o.count &&
      image == o.image &&
      project == o.project &&
      is_subtask == o.is_subtask &&
      is_epic == o.is_epic
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



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
280
281
282
 
# File 'lib/athenian/models/jira_issue_type.rb', line 245

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/athenian/models/jira_issue_type.rb', line 316

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/athenian/models/jira_issue_type.rb', line 221

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


201
202
203
 
# File 'lib/athenian/models/jira_issue_type.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/athenian/models/jira_issue_type.rb', line 207

def hash
  [name, normalized_name, count, image, project, is_subtask, is_epic].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



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

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

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

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

  if @count < 1
    invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
  end

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

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

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

  if @is_epic.nil?
    invalid_properties.push('invalid value for "is_epic", is_epic 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



292
293
294
 
# File 'lib/athenian/models/jira_issue_type.rb', line 292

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/athenian/models/jira_issue_type.rb', line 298

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



286
287
288
 
# File 'lib/athenian/models/jira_issue_type.rb', line 286

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



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/athenian/models/jira_issue_type.rb', line 159

def valid?
  return false if @name.nil?
  return false if @normalized_name.nil?
  return false if @count.nil?
  return false if @count < 1
  return false if @image.nil?
  return false if @project.nil?
  return false if @is_subtask.nil?
  return false if @is_epic.nil?
  true
end