Class: EmassClient::MilestonesGet

Inherits:
Object
  • Object
show all
Defined in:
lib/emass_client/models/milestones_get.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MilestonesGet

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/emass_client/models/milestones_get.rb', line 112

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::MilestonesGet` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::MilestonesGet`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_by ⇒ Object

Read-Only

Last, first name of the user that created the milestone.



37
38
39
 
# File 'lib/emass_client/models/milestones_get.rb', line 37

def created_by
  @created_by
end

#created_date ⇒ Object

Read-Only

Timestamp representing when the milestone was entered into the database.



40
41
42
 
# File 'lib/emass_client/models/milestones_get.rb', line 40

def created_date
  @created_date
end

#description ⇒ Object

Required

Include milestone description.



28
29
30
 
# File 'lib/emass_client/models/milestones_get.rb', line 28

def description
  @description
end

#milestone_id ⇒ Object

Required

Unique item identifier.



22
23
24
 
# File 'lib/emass_client/models/milestones_get.rb', line 22

def milestone_id
  @milestone_id
end

#poam_id ⇒ Object

Required

Unique item identifier.



25
26
27
 
# File 'lib/emass_client/models/milestones_get.rb', line 25

def poam_id
  @poam_id
end

#review_status ⇒ Object

Read-Only

Values include the following options: (Not Approved,Under Review,Approved).



34
35
36
 
# File 'lib/emass_client/models/milestones_get.rb', line 34

def review_status
  @review_status
end

#scheduled_completion_date ⇒ Object

Required

Required for ongoing and completed POA&M items. Unix time format.



31
32
33
 
# File 'lib/emass_client/models/milestones_get.rb', line 31

def scheduled_completion_date
  @scheduled_completion_date
end

#system_id ⇒ Object

Required

Unique eMASS system identifier.



19
20
21
 
# File 'lib/emass_client/models/milestones_get.rb', line 19

def system_id
  @system_id
end

Class Method Details

._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



240
241
242
243
244
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
 
# File 'lib/emass_client/models/milestones_get.rb', line 240

def self._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 = EmassClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



79
80
81
 
# File 'lib/emass_client/models/milestones_get.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/emass_client/models/milestones_get.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/emass_client/models/milestones_get.rb', line 65

def self.attribute_map
  {
    :'system_id' => :'systemId',
    :'milestone_id' => :'milestoneId',
    :'poam_id' => :'poamId',
    :'description' => :'description',
    :'scheduled_completion_date' => :'scheduledCompletionDate',
    :'review_status' => :'reviewStatus',
    :'created_by' => :'createdBy',
    :'created_date' => :'createdDate'
  }
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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/emass_client/models/milestones_get.rb', line 216

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
108
 
# File 'lib/emass_client/models/milestones_get.rb', line 103

def self.openapi_nullable
  Set.new([
    :'review_status',
    :'created_by',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/emass_client/models/milestones_get.rb', line 89

def self.openapi_types
  {
    :'system_id' => :'Integer',
    :'milestone_id' => :'Integer',
    :'poam_id' => :'Integer',
    :'description' => :'String',
    :'scheduled_completion_date' => :'Integer',
    :'review_status' => :'String',
    :'created_by' => :'String',
    :'created_date' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/emass_client/models/milestones_get.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      system_id == o.system_id &&
      milestone_id == o.milestone_id &&
      poam_id == o.poam_id &&
      description == o.description &&
      scheduled_completion_date == o.scheduled_completion_date &&
      review_status == o.review_status &&
      created_by == o.created_by &&
      created_date == o.created_date
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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/emass_client/models/milestones_get.rb', line 311

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
 
# File 'lib/emass_client/models/milestones_get.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/emass_client/models/milestones_get.rb', line 209

def hash
  [system_id, milestone_id, poam_id, description, scheduled_completion_date, review_status, created_by, created_date].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



161
162
163
164
165
 
# File 'lib/emass_client/models/milestones_get.rb', line 161

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



287
288
289
 
# File 'lib/emass_client/models/milestones_get.rb', line 287

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/emass_client/models/milestones_get.rb', line 293

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



281
282
283
 
# File 'lib/emass_client/models/milestones_get.rb', line 281

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



169
170
171
172
173
174
 
# File 'lib/emass_client/models/milestones_get.rb', line 169

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  review_status_validator = EnumAttributeValidator.new('String', ["Not Approved", "Under Review", "Approved", "unknown_default_open_api"])
  return false unless review_status_validator.valid?(@review_status)
  true
end