class PureCloud::WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast
Attributes
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 46 def self.attribute_map { :'id' => :'id', :'week_date' => :'weekDate', :'creation_method' => :'creationMethod', :'description' => :'description', :'legacy' => :'legacy', :'reference_start_date' => :'referenceStartDate', :'source_days' => :'sourceDays', :'modifications' => :'modifications', :'time_zone' => :'timeZone', :'planning_groups_version' => :'planningGroupsVersion', :'week_count' => :'weekCount', :'metadata' => :'metadata' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 109 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'weekDate') self.week_date = attributes[:'weekDate'] end if attributes.has_key?(:'creationMethod') self.creation_method = attributes[:'creationMethod'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'legacy') self.legacy = attributes[:'legacy'] end if attributes.has_key?(:'referenceStartDate') self.reference_start_date = attributes[:'referenceStartDate'] end if attributes.has_key?(:'sourceDays') if (value = attributes[:'sourceDays']).is_a?(Array) self.source_days = value end end if attributes.has_key?(:'modifications') if (value = attributes[:'modifications']).is_a?(Array) self.modifications = value end end if attributes.has_key?(:'timeZone') self.time_zone = attributes[:'timeZone'] end if attributes.has_key?(:'planningGroupsVersion') self.planning_groups_version = attributes[:'planningGroupsVersion'] end if attributes.has_key?(:'weekCount') self.week_count = attributes[:'weekCount'] end if attributes.has_key?(:'metadata') self.metadata = attributes[:'metadata'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 77 def self.swagger_types { :'id' => :'String', :'week_date' => :'String', :'creation_method' => :'String', :'description' => :'String', :'legacy' => :'BOOLEAN', :'reference_start_date' => :'DateTime', :'source_days' => :'Array<WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer>', :'modifications' => :'Array<WfmBuShortTermForecastImportCompleteTopicBuForecastModification>', :'time_zone' => :'String', :'planning_groups_version' => :'Integer', :'week_count' => :'Integer', :'metadata' => :'WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 370 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && week_date == o.week_date && creation_method == o.creation_method && description == o.description && legacy == o.legacy && reference_start_date == o.reference_start_date && source_days == o.source_days && modifications == o.modifications && time_zone == o.time_zone && planning_groups_version == o.planning_groups_version && week_count == o.week_count && metadata == o.metadata end
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 419 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/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 479 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/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 400 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] creation_method
Object to be assigned
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 312 def creation_method=(creation_method) allowed_values = ["Import", "ImportedHistoricalWeightedAverage", "HistoricalWeightedAverage", "Advanced"] if creation_method && !allowed_values.include?(creation_method) fail ArgumentError, "invalid value for 'creation_method', must be one of #{allowed_values}." end @creation_method = creation_method end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 389 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 395 def hash [id, week_date, creation_method, description, legacy, reference_start_date, source_days, modifications, time_zone, planning_groups_version, week_count, metadata].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/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 232 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 467 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/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 457 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/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb, line 241 def valid? allowed_values = ["Import", "ImportedHistoricalWeightedAverage", "HistoricalWeightedAverage", "Advanced"] if @creation_method && !allowed_values.include?(@creation_method) return false end end