Class: Athenian::GetJIRAIssuesRequest

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

Overview

Request body for the get_jira_issues operation. Declaration of which issues the user wants to retrieve.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetJIRAIssuesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 56

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

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

Instance Attribute Details

#account ⇒ Object

Account ID.



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

def 
  @account
end

#include ⇒ Object

Additional informations to include in the response.



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

def include
  @include
end

#issues ⇒ Object

List of issue identifiers (issue keys) to retrieve. The order of the requested issues will be preserved in the response.



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

def issues
  @issues
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 26

def self.attribute_map
  {
    :'account' => :'account',
    :'include' => :'include',
    :'issues' => :'issues'
  }
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



153
154
155
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 153

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 40

def self.openapi_types
  {
    :'account' => :'Integer',
    :'include' => :'Array<GetJIRAIssuesInclude>',
    :'issues' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



130
131
132
133
134
135
136
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 130

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      include == o.include &&
      issues == o.issues
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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 255

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 160

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


140
141
142
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



146
147
148
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 146

def hash
  [, include, issues].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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 88

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

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

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



231
232
233
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 231

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



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

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



225
226
227
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 225

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



107
108
109
110
111
112
 
# File 'lib/athenian/models/get_jira_issues_request.rb', line 107

def valid?
  return false if @account.nil?
  return false if @issues.nil?
  return false if @issues.length < 1
  true
end