class PureCloud::ReportRunEntry
Attributes
The globally unique identifier for the object.
Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The URI for this object
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 47 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'report_id' => :'reportId', :'run_time' => :'runTime', :'run_status' => :'runStatus', :'error_message' => :'errorMessage', :'run_duration_msec' => :'runDurationMsec', :'report_url' => :'reportUrl', :'report_format' => :'reportFormat', :'schedule_uri' => :'scheduleUri', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 106 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'reportId') self.report_id = attributes[:'reportId'] end if attributes.has_key?(:'runTime') self.run_time = attributes[:'runTime'] end if attributes.has_key?(:'runStatus') self.run_status = attributes[:'runStatus'] end if attributes.has_key?(:'errorMessage') self.error_message = attributes[:'errorMessage'] end if attributes.has_key?(:'runDurationMsec') self.run_duration_msec = attributes[:'runDurationMsec'] end if attributes.has_key?(:'reportUrl') self.report_url = attributes[:'reportUrl'] end if attributes.has_key?(:'reportFormat') self.report_format = attributes[:'reportFormat'] end if attributes.has_key?(:'scheduleUri') self.schedule_uri = attributes[:'scheduleUri'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 76 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'report_id' => :'String', :'run_time' => :'DateTime', :'run_status' => :'String', :'error_message' => :'String', :'run_duration_msec' => :'Integer', :'report_url' => :'String', :'report_format' => :'String', :'schedule_uri' => :'String', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 345 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && report_id == o.report_id && run_time == o.run_time && run_status == o.run_status && error_message == o.error_message && run_duration_msec == o.run_duration_msec && report_url == o.report_url && report_format == o.report_format && schedule_uri == o.schedule_uri && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 393 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/report_run_entry.rb, line 453 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/report_run_entry.rb, line 374 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/report_run_entry.rb, line 363 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 369 def hash [id, name, report_id, run_time, run_status, error_message, run_duration_msec, report_url, report_format, schedule_uri, 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/report_run_entry.rb, line 216 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] run_status
Object to be assigned
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 302 def run_status=(run_status) allowed_values = ["RUNNING", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "FAILED_TIMEOUT", "FAILED_DATALIMIT", "UNABLE_TO_COMPLETE"] if run_status && !allowed_values.include?(run_status) fail ArgumentError, "invalid value for 'run_status', must be one of #{allowed_values}." end @run_status = run_status end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/report_run_entry.rb, line 441 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/report_run_entry.rb, line 431 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/report_run_entry.rb, line 225 def valid? allowed_values = ["RUNNING", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "FAILED_TIMEOUT", "FAILED_DATALIMIT", "UNABLE_TO_COMPLETE"] if @run_status && !allowed_values.include?(@run_status) return false end end