class PureCloud::BuScheduleMetadata
Attributes
The description of this schedule
Generation result summary for this schedule, if applicable
The globally unique identifier for the object.
High level per-management unit schedule metadata
Version metadata for this schedule
Whether this schedule is published
The URI for this object
The forecast used for this schedule, if applicable
The number of weeks spanned by this schedule
The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 52 def self.attribute_map { :'id' => :'id', :'week_date' => :'weekDate', :'week_count' => :'weekCount', :'description' => :'description', :'published' => :'published', :'short_term_forecast' => :'shortTermForecast', :'generation_results' => :'generationResults', :'metadata' => :'metadata', :'management_units' => :'managementUnits', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 107 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?(:'weekCount') self.week_count = attributes[:'weekCount'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'published') self.published = attributes[:'published'] end if attributes.has_key?(:'shortTermForecast') self.short_term_forecast = attributes[:'shortTermForecast'] end if attributes.has_key?(:'generationResults') self.generation_results = attributes[:'generationResults'] end if attributes.has_key?(:'metadata') self.metadata = attributes[:'metadata'] end if attributes.has_key?(:'managementUnits') if (value = attributes[:'managementUnits']).is_a?(Array) self.management_units = value end end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 79 def self.swagger_types { :'id' => :'String', :'week_date' => :'Date', :'week_count' => :'Integer', :'description' => :'String', :'published' => :'BOOLEAN', :'short_term_forecast' => :'BuShortTermForecastReference', :'generation_results' => :'ScheduleGenerationResultSummary', :'metadata' => :'WfmVersionedEntityMetadata', :'management_units' => :'Array<BuManagementUnitScheduleSummary>', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 316 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && week_date == o.week_date && week_count == o.week_count && description == o.description && published == o.published && short_term_forecast == o.short_term_forecast && generation_results == o.generation_results && metadata == o.metadata && management_units == o.management_units && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 363 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/bu_schedule_metadata.rb, line 423 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/bu_schedule_metadata.rb, line 344 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 333 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 339 def hash [id, week_date, week_count, description, published, short_term_forecast, generation_results, metadata, management_units, self_uri].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/bu_schedule_metadata.rb, line 210 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb, line 411 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/bu_schedule_metadata.rb, line 401 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/bu_schedule_metadata.rb, line 219 def valid? end