class FlatApi::ScoreCommentUpdate
Update of a comment
Attributes
The comment text that can includes mentions using the following format: `@[id:username]`.
A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set.
The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains "last", the API will automatically take the last revision created.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/flat_api/models/score_comment_update.rb, line 31 def self.attribute_map { :'revision' => :'revision', :'comment' => :'comment', :'raw_comment' => :'rawComment', :'context' => :'context' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/flat_api/models/score_comment_update.rb, line 52 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'revision') self.revision = attributes[:'revision'] end if attributes.has_key?(:'comment') self.comment = attributes[:'comment'] end if attributes.has_key?(:'rawComment') self.raw_comment = attributes[:'rawComment'] end if attributes.has_key?(:'context') self.context = attributes[:'context'] end end
Attribute type mapping.
# File lib/flat_api/models/score_comment_update.rb, line 41 def self.swagger_types { :'revision' => :'String', :'comment' => :'String', :'raw_comment' => :'String', :'context' => :'ScoreCommentContext' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/flat_api/models/score_comment_update.rb, line 141 def ==(o) return true if self.equal?(o) self.class == o.class && revision == o.revision && comment == o.comment && raw_comment == o.raw_comment && context == o.context end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/flat_api/models/score_comment_update.rb, line 186 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = FlatApi.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/flat_api/models/score_comment_update.rb, line 252 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/flat_api/models/score_comment_update.rb, line 165 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method with validation @param [Object] comment Value to be assigned
# File lib/flat_api/models/score_comment_update.rb, line 111 def comment=(comment) if !comment.nil? && comment.to_s.length > 10000 fail ArgumentError, "invalid value for 'comment', the character length must be smaller than or equal to 10000." end if !comment.nil? && comment.to_s.length < 1 fail ArgumentError, "invalid value for 'comment', the character length must be great than or equal to 1." end @comment = comment end
@see the `==` method @param [Object] Object to be compared
# File lib/flat_api/models/score_comment_update.rb, line 152 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/flat_api/models/score_comment_update.rb, line 158 def hash [revision, comment, raw_comment, context].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/flat_api/models/score_comment_update.rb, line 78 def list_invalid_properties invalid_properties = Array.new if !@comment.nil? && @comment.to_s.length > 10000 invalid_properties.push("invalid value for 'comment', the character length must be smaller than or equal to 10000.") end if !@comment.nil? && @comment.to_s.length < 1 invalid_properties.push("invalid value for 'comment', the character length must be great than or equal to 1.") end if !@raw_comment.nil? && @raw_comment.to_s.length > 10000 invalid_properties.push("invalid value for 'raw_comment', the character length must be smaller than or equal to 10000.") end if !@raw_comment.nil? && @raw_comment.to_s.length < 1 invalid_properties.push("invalid value for 'raw_comment', the character length must be great than or equal to 1.") end return invalid_properties end
Custom attribute writer method with validation @param [Object] raw_comment
Value to be assigned
# File lib/flat_api/models/score_comment_update.rb, line 126 def raw_comment=(raw_comment) if !raw_comment.nil? && raw_comment.to_s.length > 10000 fail ArgumentError, "invalid value for 'raw_comment', the character length must be smaller than or equal to 10000." end if !raw_comment.nil? && raw_comment.to_s.length < 1 fail ArgumentError, "invalid value for 'raw_comment', the character length must be great than or equal to 1." end @raw_comment = raw_comment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/flat_api/models/score_comment_update.rb, line 238 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/flat_api/models/score_comment_update.rb, line 226 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/flat_api/models/score_comment_update.rb, line 101 def valid? return false if !@comment.nil? && @comment.to_s.length > 10000 return false if !@comment.nil? && @comment.to_s.length < 1 return false if !@raw_comment.nil? && @raw_comment.to_s.length > 10000 return false if !@raw_comment.nil? && @raw_comment.to_s.length < 1 return true end