class NucleusApi::Model
Model
Object
Attributes
benchmarkId
cashSec
category
clientId
defaultDriftFactor
description
downside
driftRebal
isActive
name
periodRebal
rebalancePeriod
safeSec
secRotation
taxEfficiencyId
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/nucleus_api/models/model.rb, line 79 def self.attribute_map { :'benchmark_id' => :'benchmark_id', :'cash_sec' => :'cash_sec', :'category' => :'category', :'client_id' => :'client_id', :'create_date' => :'create_date', :'currency_code' => :'currency_code', :'default_drift_factor' => :'default_drift_factor', :'description' => :'description', :'downside' => :'downside', :'drift_rebal' => :'drift_rebal', :'id' => :'id', :'is_active' => :'is_active', :'metadata' => :'metadata', :'name' => :'name', :'node_map' => :'node_map', :'period_rebal' => :'period_rebal', :'rebalance_period' => :'rebalance_period', :'safe_sec' => :'safe_sec', :'sec_rotation' => :'sec_rotation', :'secondary_id' => :'secondary_id', :'tax_efficiency_id' => :'tax_efficiency_id', :'update_date' => :'update_date' } end
Initializes the object @param [Hash] attributes Model
attributes in the form of hash
# File lib/nucleus_api/models/model.rb, line 136 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?(:'benchmark_id') self.benchmark_id = attributes[:'benchmark_id'] end if attributes.has_key?(:'cash_sec') self.cash_sec = attributes[:'cash_sec'] end if attributes.has_key?(:'category') self.category = attributes[:'category'] end if attributes.has_key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.has_key?(:'create_date') self.create_date = attributes[:'create_date'] end if attributes.has_key?(:'currency_code') self.currency_code = attributes[:'currency_code'] end if attributes.has_key?(:'default_drift_factor') self.default_drift_factor = attributes[:'default_drift_factor'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'downside') self.downside = attributes[:'downside'] end if attributes.has_key?(:'drift_rebal') self.drift_rebal = attributes[:'drift_rebal'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'is_active') self.is_active = attributes[:'is_active'] end if attributes.has_key?(:'metadata') if (value = attributes[:'metadata']).is_a?(Hash) self.metadata = value end end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'node_map') if (value = attributes[:'node_map']).is_a?(Array) self.node_map = value end end if attributes.has_key?(:'period_rebal') self.period_rebal = attributes[:'period_rebal'] end if attributes.has_key?(:'rebalance_period') self.rebalance_period = attributes[:'rebalance_period'] end if attributes.has_key?(:'safe_sec') self.safe_sec = attributes[:'safe_sec'] end if attributes.has_key?(:'sec_rotation') self.sec_rotation = attributes[:'sec_rotation'] end if attributes.has_key?(:'secondary_id') self.secondary_id = attributes[:'secondary_id'] end if attributes.has_key?(:'tax_efficiency_id') self.tax_efficiency_id = attributes[:'tax_efficiency_id'] end if attributes.has_key?(:'update_date') self.update_date = attributes[:'update_date'] end end
Attribute type mapping.
# File lib/nucleus_api/models/model.rb, line 107 def self.swagger_types { :'benchmark_id' => :'String', :'cash_sec' => :'String', :'category' => :'String', :'client_id' => :'String', :'create_date' => :'DateTime', :'currency_code' => :'String', :'default_drift_factor' => :'Float', :'description' => :'String', :'downside' => :'BOOLEAN', :'drift_rebal' => :'BOOLEAN', :'id' => :'String', :'is_active' => :'BOOLEAN', :'metadata' => :'Hash<String, String>', :'name' => :'String', :'node_map' => :'Array<AllocationNodeMap>', :'period_rebal' => :'BOOLEAN', :'rebalance_period' => :'Integer', :'safe_sec' => :'String', :'sec_rotation' => :'BOOLEAN', :'secondary_id' => :'String', :'tax_efficiency_id' => :'Integer', :'update_date' => :'DateTime' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/nucleus_api/models/model.rb, line 255 def ==(o) return true if self.equal?(o) self.class == o.class && benchmark_id == o.benchmark_id && cash_sec == o.cash_sec && category == o.category && client_id == o.client_id && create_date == o.create_date && currency_code == o.currency_code && default_drift_factor == o.default_drift_factor && description == o.description && downside == o.downside && drift_rebal == o.drift_rebal && id == o.id && is_active == o.is_active && metadata == o.metadata && name == o.name && node_map == o.node_map && period_rebal == o.period_rebal && rebalance_period == o.rebalance_period && safe_sec == o.safe_sec && sec_rotation == o.sec_rotation && secondary_id == o.secondary_id && tax_efficiency_id == o.tax_efficiency_id && update_date == o.update_date 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/nucleus_api/models/model.rb, line 316 def _deserialize(type, value) case type.to_sym when :DateTime (value) when :Date (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 = NucleusApi.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/nucleus_api/models/model.rb, line 382 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/nucleus_api/models/model.rb, line 297 def build_from_hash(attributes) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/nucleus_api/models/model.rb, line 284 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/nucleus_api/models/model.rb, line 290 def hash [benchmark_id, cash_sec, category, client_id, create_date, currency_code, default_drift_factor, description, downside, drift_rebal, id, is_active, metadata, name, node_map, period_rebal, rebalance_period, safe_sec, sec_rotation, secondary_id, tax_efficiency_id, update_date].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/nucleus_api/models/model.rb, line 237 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/nucleus_api/models/model.rb, line 369 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/nucleus_api/models/model.rb, line 357 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/nucleus_api/models/model.rb, line 248 def valid? return false if @name.nil? true end