class PureCloud::ForecastSourceDayPointer
Pointer to look up source data for a short term forecast
Attributes
The key to look up the forecast source data for this source day
The date this source data represents, in yyyy-MM-dd format
The forecast day of week for this source data
The name of the source file this data came from if it originated from a data import
The relative weight to apply to this source data item for weighted averages
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 38 def self.attribute_map { :'day_of_week' => :'dayOfWeek', :'weight' => :'weight', :'date' => :'date', :'file_name' => :'fileName', :'data_key' => :'dataKey' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 73 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?(:'dayOfWeek') self.day_of_week = attributes[:'dayOfWeek'] end if attributes.has_key?(:'weight') self.weight = attributes[:'weight'] end if attributes.has_key?(:'date') self.date = attributes[:'date'] end if attributes.has_key?(:'fileName') self.file_name = attributes[:'fileName'] end if attributes.has_key?(:'dataKey') self.data_key = attributes[:'dataKey'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 55 def self.swagger_types { :'day_of_week' => :'String', :'weight' => :'Integer', :'date' => :'String', :'file_name' => :'String', :'data_key' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 204 def ==(o) return true if self.equal?(o) self.class == o.class && day_of_week == o.day_of_week && weight == o.weight && date == o.date && file_name == o.file_name && data_key == o.data_key end
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 246 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 306 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 the object from hash
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 227 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
Custom attribute writer method checking allowed values (enum). @param [Object] day_of_week
Object to be assigned
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 171 def day_of_week=(day_of_week) allowed_values = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "EighthDay"] if day_of_week && !allowed_values.include?(day_of_week) fail ArgumentError, "invalid value for 'day_of_week', must be one of #{allowed_values}." end @day_of_week = day_of_week end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 216 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 222 def hash [day_of_week, weight, date, file_name, data_key].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 129 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 294 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
# File lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 284 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/purecloudplatformclientv2/models/forecast_source_day_pointer.rb, line 138 def valid? allowed_values = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "EighthDay"] if @day_of_week && !allowed_values.include?(@day_of_week) return false end end