class PureCloud::ApiUsageQuery
Attributes
Date granularity of the results
Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 34 def self.attribute_map { :'interval' => :'interval', :'granularity' => :'granularity', :'group_by' => :'groupBy', :'metrics' => :'metrics' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 65 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?(:'interval') self.interval = attributes[:'interval'] end if attributes.has_key?(:'granularity') self.granularity = attributes[:'granularity'] end if attributes.has_key?(:'groupBy') if (value = attributes[:'groupBy']).is_a?(Array) self.group_by = value end end if attributes.has_key?(:'metrics') if (value = attributes[:'metrics']).is_a?(Array) self.metrics = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 49 def self.swagger_types { :'interval' => :'String', :'granularity' => :'String', :'group_by' => :'Array<String>', :'metrics' => :'Array<String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 187 def ==(o) return true if self.equal?(o) self.class == o.class && interval == o.interval && granularity == o.granularity && group_by == o.group_by && metrics == o.metrics end
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 228 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/api_usage_query.rb, line 288 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/api_usage_query.rb, line 209 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/api_usage_query.rb, line 198 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] granularity Object to be assigned
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 164 def granularity=(granularity) allowed_values = ["Day", "Week", "Month"] if granularity && !allowed_values.include?(granularity) fail ArgumentError, "invalid value for 'granularity', must be one of #{allowed_values}." end @granularity = granularity end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 204 def hash [interval, granularity, group_by, metrics].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/api_usage_query.rb, line 116 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/api_usage_query.rb, line 276 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/api_usage_query.rb, line 266 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/api_usage_query.rb, line 125 def valid? if @interval.nil? return false end allowed_values = ["Day", "Week", "Month"] if @granularity && !allowed_values.include?(@granularity) return false end end