Class: IntersightClient::FeedbackFeedbackData

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/feedback_feedback_data.rb

Overview

Feedback data that collected on the UI from user.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FeedbackFeedbackData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 135

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::FeedbackFeedbackData` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'feedback.FeedbackData'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'feedback.FeedbackData'
  end

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

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

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

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

  if attributes.key?(:'evaluation')
    self.evaluation = attributes[:'evaluation']
  else
    self.evaluation = 'Excellent'
  end

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'Evaluation'
  end
end

Instance Attribute Details

#account_name ⇒ Object

Account name of the feedback sender. Copied in order to be persisted in case of account removal.



26
27
28
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 26

def 
  @account_name
end

#alternative_follow_up_emails ⇒ Object

Returns the value of attribute alternative_follow_up_emails.



28
29
30
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 28

def alternative_follow_up_emails
  @alternative_follow_up_emails
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 20

def class_id
  @class_id
end

#comment ⇒ Object

Text of the feedback as provided by the user, if it is a bug or a comment.



31
32
33
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 31

def comment
  @comment
end

#email ⇒ Object

User’s email address details.



34
35
36
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 34

def email
  @email
end

#evaluation ⇒ Object

Evalation rating as provided by the user to capture user sentiment regarding the issue. * Excellent - Option that specifies user’s excelent evaluation. * Poor - Option that specifies user’s poor evaluation. * Fair - Option that specifies user’s fair evaluation. * Good - Option that specifies user’s good evaluation.



37
38
39
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 37

def evaluation
  @evaluation
end

#follow_up ⇒ Object

If a user is open for follow-up or not.



40
41
42
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 40

def follow_up
  @follow_up
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 23

def object_type
  @object_type
end

#trace_ids ⇒ Object

Bunch of last traceId for reproducing user last activity.



43
44
45
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 43

def trace_ids
  @trace_ids
end

#type ⇒ Object

Type of the feedback from user. * Evaluation - User’s feedback classified as an evaluation. * Bug - User’s feedback classified as a bug.



46
47
48
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 46

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



92
93
94
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 92

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



87
88
89
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 87

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 71

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'account_name' => :'AccountName',
    :'alternative_follow_up_emails' => :'AlternativeFollowUpEmails',
    :'comment' => :'Comment',
    :'email' => :'Email',
    :'evaluation' => :'Evaluation',
    :'follow_up' => :'FollowUp',
    :'trace_ids' => :'TraceIds',
    :'type' => :'Type'
  }
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



335
336
337
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 335

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



121
122
123
124
125
126
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 121

def self.openapi_all_of
  [
  :'FeedbackFeedbackDataAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



129
130
131
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 129

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
118
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 113

def self.openapi_nullable
  Set.new([
    :'alternative_follow_up_emails',
    :'trace_ids',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 97

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'account_name' => :'String',
    :'alternative_follow_up_emails' => :'Array<String>',
    :'comment' => :'String',
    :'email' => :'String',
    :'evaluation' => :'String',
    :'follow_up' => :'Boolean',
    :'trace_ids' => :'Object',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 305

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
       == o. &&
      alternative_follow_up_emails == o.alternative_follow_up_emails &&
      comment == o.comment &&
      email == o.email &&
      evaluation == o.evaluation &&
      follow_up == o.follow_up &&
      trace_ids == o.trace_ids &&
      type == o.type && super(o)
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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 366

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 = IntersightClient.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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 437

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 342

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


322
323
324
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



328
329
330
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 328

def hash
  [class_id, object_type, , alternative_follow_up_emails, comment, email, evaluation, follow_up, trace_ids, type].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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 204

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

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

  if !@alternative_follow_up_emails.nil? && @alternative_follow_up_emails.length > 5
    invalid_properties.push('invalid value for "alternative_follow_up_emails", number of items must be less than or equal to 5.')
  end

  if !@comment.nil? && @comment.to_s.length > 1500
    invalid_properties.push('invalid value for "comment", the character length must be smaller than or equal to 1500.')
  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



413
414
415
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 419

def to_hash
  hash = super
  FeedbackFeedbackData.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = FeedbackFeedbackData.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



407
408
409
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 407

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intersight_client/models/feedback_feedback_data.rb', line 227

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["feedback.FeedbackData"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["feedback.FeedbackData"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@alternative_follow_up_emails.nil? && @alternative_follow_up_emails.length > 5
  return false if !@comment.nil? && @comment.to_s.length > 1500
  evaluation_validator = EnumAttributeValidator.new('String', ["Excellent", "Poor", "Fair", "Good"])
  return false unless evaluation_validator.valid?(@evaluation)
  type_validator = EnumAttributeValidator.new('String', ["Evaluation", "Bug"])
  return false unless type_validator.valid?(@type)
  true && super
end