class PureCloud::AuditLogMessage
Attributes
Action
that took place.
Client associated with this audit message.
Additional context for this message.
Entity that was impacted.
Type of the entity that was impacted.
Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
Id of the audit message.
Message
describing the event being audited.
List of properties that were changed and changes made to those properties.
List of IP addresses of systems that originated or handled the request.
Name of the service that logged this audit message.
User
associated with this audit message.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 58 def self.attribute_map { :'id' => :'id', :'user' => :'user', :'client' => :'client', :'remote_ip' => :'remoteIp', :'service_name' => :'serviceName', :'event_date' => :'eventDate', :'message' => :'message', :'action' => :'action', :'entity' => :'entity', :'entity_type' => :'entityType', :'property_changes' => :'propertyChanges', :'context' => :'context' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 121 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?(:'user') self.user = attributes[:'user'] end if attributes.has_key?(:'client') self.client = attributes[:'client'] end if attributes.has_key?(:'remoteIp') if (value = attributes[:'remoteIp']).is_a?(Array) self.remote_ip = value end end if attributes.has_key?(:'serviceName') self.service_name = attributes[:'serviceName'] end if attributes.has_key?(:'eventDate') self.event_date = attributes[:'eventDate'] end if attributes.has_key?(:'message') self.message = attributes[:'message'] end if attributes.has_key?(:'action') self.action = attributes[:'action'] end if attributes.has_key?(:'entity') self.entity = attributes[:'entity'] end if attributes.has_key?(:'entityType') self.entity_type = attributes[:'entityType'] end if attributes.has_key?(:'propertyChanges') if (value = attributes[:'propertyChanges']).is_a?(Array) self.property_changes = value end end if attributes.has_key?(:'context') if (value = attributes[:'context']).is_a?(Array) self.context = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 89 def self.swagger_types { :'id' => :'String', :'user' => :'DomainEntityRef', :'client' => :'AddressableEntityRef', :'remote_ip' => :'Array<String>', :'service_name' => :'String', :'event_date' => :'DateTime', :'message' => :'MessageInfo', :'action' => :'String', :'entity' => :'AddressableEntityRef', :'entity_type' => :'String', :'property_changes' => :'Array<PropertyChange>', :'context' => :'Hash<String, String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 412 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && user == o.user && client == o.client && remote_ip == o.remote_ip && service_name == o.service_name && event_date == o.event_date && message == o.message && action == o.action && entity == o.entity && entity_type == o.entity_type && property_changes == o.property_changes && context == o.context end
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 461 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/audit_log_message.rb, line 521 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
Custom attribute writer method checking allowed values (enum). @param [Object] action Object to be assigned
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 370 def action=(action) allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "ApplyProtection", "RevokeProtection", "UpdateRetention", "ReadAll", "Execute", "Publish", "Unpublish", "Enable", "Disable", "Authorize", "Deauthorize", "Authenticate", "ChangePassword"] if action && !allowed_values.include?(action) fail ArgumentError, "invalid value for 'action', must be one of #{allowed_values}." end @action = action end
build the object from hash
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 442 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] entity_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 389 def entity_type=(entity_type) allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "SessionType", "EventType", "ClickstreamSettings", "Schedule", "Trigger", "Response"] if entity_type && !allowed_values.include?(entity_type) fail ArgumentError, "invalid value for 'entity_type', must be one of #{allowed_values}." end @entity_type = entity_type end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 431 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 437 def hash [id, user, client, remote_ip, service_name, event_date, message, action, entity, entity_type, property_changes, context].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/audit_log_message.rb, line 246 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] service_name
Object to be assigned
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 346 def service_name=(service_name) allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement", "Triggers", "ResponseManagement"] if service_name && !allowed_values.include?(service_name) fail ArgumentError, "invalid value for 'service_name', must be one of #{allowed_values}." end @service_name = service_name end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/audit_log_message.rb, line 509 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/audit_log_message.rb, line 499 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/audit_log_message.rb, line 255 def valid? allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitions", "PredictiveEngagement", "WorkforceManagement", "Triggers", "ResponseManagement"] if @service_name && !allowed_values.include?(@service_name) return false end allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "ApplyProtection", "RevokeProtection", "UpdateRetention", "ReadAll", "Execute", "Publish", "Unpublish", "Enable", "Disable", "Authorize", "Deauthorize", "Authenticate", "ChangePassword"] if @action && !allowed_values.include?(@action) return false end allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "OAuthClient", "OAuthClientAuthorization", "AuthOrganization", "AuthUser", "BulkActions", "Feedback", "Topic", "Program", "Segment", "Outcome", "SessionType", "EventType", "ClickstreamSettings", "Schedule", "Trigger", "Response"] if @entity_type && !allowed_values.include?(@entity_type) return false end end