class PureCloud::TrusteeAuditQueryRequest
Attributes
Ending date/time for the audit search. ISO-8601 formatted date-time, UTC.
Facet
information to be returned with the query results.
Additional custom filters to be applied to the query.
Word or phrase to look for in audit bodies.
Starting date/time for the audit search. ISO-8601 formatted date-time, UTC.
Limit returned audits to these trustee organizationIds.
Limit returned audits to these trustee userIds.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb, line 43 def self.attribute_map { :'trustee_organization_ids' => :'trusteeOrganizationIds', :'trustee_user_ids' => :'trusteeUserIds', :'start_date' => :'startDate', :'end_date' => :'endDate', :'query_phrase' => :'queryPhrase', :'facets' => :'facets', :'filters' => :'filters' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb, line 86 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?(:'trusteeOrganizationIds') if (value = attributes[:'trusteeOrganizationIds']).is_a?(Array) self.trustee_organization_ids = value end end if attributes.has_key?(:'trusteeUserIds') if (value = attributes[:'trusteeUserIds']).is_a?(Array) self.trustee_user_ids = value end end if attributes.has_key?(:'startDate') self.start_date = attributes[:'startDate'] end if attributes.has_key?(:'endDate') self.end_date = attributes[:'endDate'] end if attributes.has_key?(:'queryPhrase') self.query_phrase = attributes[:'queryPhrase'] end if attributes.has_key?(:'facets') if (value = attributes[:'facets']).is_a?(Array) self.facets = value end end if attributes.has_key?(:'filters') if (value = attributes[:'filters']).is_a?(Array) self.filters = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb, line 64 def self.swagger_types { :'trustee_organization_ids' => :'Array<String>', :'trustee_user_ids' => :'Array<String>', :'start_date' => :'DateTime', :'end_date' => :'DateTime', :'query_phrase' => :'String', :'facets' => :'Array<Facet>', :'filters' => :'Array<Filter>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb, line 257 def ==(o) return true if self.equal?(o) self.class == o.class && trustee_organization_ids == o.trustee_organization_ids && trustee_user_ids == o.trustee_user_ids && start_date == o.start_date && end_date == o.end_date && query_phrase == o.query_phrase && facets == o.facets && filters == o.filters end
# File lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb, line 301 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/trustee_audit_query_request.rb, line 361 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/trustee_audit_query_request.rb, line 282 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/trustee_audit_query_request.rb, line 271 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb, line 277 def hash [trustee_organization_ids, trustee_user_ids, start_date, end_date, query_phrase, facets, filters].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/trustee_audit_query_request.rb, line 168 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb, line 349 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/trustee_audit_query_request.rb, line 339 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/trustee_audit_query_request.rb, line 177 def valid? if @trustee_organization_ids.nil? return false end if @trustee_user_ids.nil? return false end end