class FlatApi::ScoreModification

Edit the score metadata

Attributes

creation_type[RW]
description[RW]

Description of the creation

license[RW]
privacy[RW]
sharing_key[RW]
tags[RW]

Tags describing the score

title[RW]

The title of the score

Public Class Methods

attribute_map() click to toggle source

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

# File lib/flat_api/models/score_modification.rb, line 37
def self.attribute_map
  {
    :'title' => :'title',
    :'privacy' => :'privacy',
    :'sharing_key' => :'sharingKey',
    :'description' => :'description',
    :'tags' => :'tags',
    :'creation_type' => :'creationType',
    :'license' => :'license'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/flat_api/models/score_modification.rb, line 64
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?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.has_key?(:'privacy')
    self.privacy = attributes[:'privacy']
  end

  if attributes.has_key?(:'sharingKey')
    self.sharing_key = attributes[:'sharingKey']
  end

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

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

  if attributes.has_key?(:'creationType')
    self.creation_type = attributes[:'creationType']
  end

  if attributes.has_key?(:'license')
    self.license = attributes[:'license']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/flat_api/models/score_modification.rb, line 50
def self.swagger_types
  {
    :'title' => :'String',
    :'privacy' => :'ScorePrivacy',
    :'sharing_key' => :'ResourceSharingKey',
    :'description' => :'String',
    :'tags' => :'Array<String>',
    :'creation_type' => :'ScoreCreationType',
    :'license' => :'ScoreLicense'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/flat_api/models/score_modification.rb, line 133
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      privacy == o.privacy &&
      sharing_key == o.sharing_key &&
      description == o.description &&
      tags == o.tags &&
      creation_type == o.creation_type &&
      license == o.license
end
_deserialize(type, value) click to toggle source

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_modification.rb, line 181
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
_to_hash(value) click to toggle source

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_modification.rb, line 247
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) click to toggle source

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_modification.rb, line 160
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
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/flat_api/models/score_modification.rb, line 122
def description=(description)

  if !description.nil? && description.to_s.length > 1000
    fail ArgumentError, "invalid value for 'description', the character length must be smaller than or equal to 1000."
  end

  @description = description
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/flat_api/models/score_modification.rb, line 147
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/flat_api/models/score_modification.rb, line 153
def hash
  [title, privacy, sharing_key, description, tags, creation_type, license].hash
end
list_invalid_properties() click to toggle source

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_modification.rb, line 104
def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 1000
    invalid_properties.push("invalid value for 'description', the character length must be smaller than or equal to 1000.")
  end

  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/flat_api/models/score_modification.rb, line 227
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/flat_api/models/score_modification.rb, line 233
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/flat_api/models/score_modification.rb, line 221
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_modification.rb, line 115
def valid?
  return false if !@description.nil? && @description.to_s.length > 1000
  return true
end