class PureCloud::ApiUsageRow

Attributes

client_id[RW]

Client Id associated with this query result

client_name[RW]

Client Name associated with this query result

date[RW]

Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

http_method[RW]

HTTP Method associated with this query result

organization_id[RW]

Organization Id associated with this query result

requests[RW]

Total number of requests

status200[RW]

Number of requests resulting in a 2xx HTTP status code

status300[RW]

Number of requests resulting in a 3xx HTTP status code

status400[RW]

Number of requests resulting in a 4xx HTTP status code

status429[RW]

Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400

status500[RW]

Number of requests resulting in a 5xx HTTP status code

template_uri[RW]

Template Uri associated with this query result

user_id[RW]

User Id associated with this query result

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 61
def self.attribute_map
  {
    
    :'client_id' => :'clientId',
    
    :'client_name' => :'clientName',
    
    :'organization_id' => :'organizationId',
    
    :'user_id' => :'userId',
    
    :'template_uri' => :'templateUri',
    
    :'http_method' => :'httpMethod',
    
    :'status200' => :'status200',
    
    :'status300' => :'status300',
    
    :'status400' => :'status400',
    
    :'status500' => :'status500',
    
    :'status429' => :'status429',
    
    :'requests' => :'requests',
    
    :'date' => :'date'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 128
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?(:'clientId')
    
    
    self.client_id = attributes[:'clientId']
    
  
  end

  
  if attributes.has_key?(:'clientName')
    
    
    self.client_name = attributes[:'clientName']
    
  
  end

  
  if attributes.has_key?(:'organizationId')
    
    
    self.organization_id = attributes[:'organizationId']
    
  
  end

  
  if attributes.has_key?(:'userId')
    
    
    self.user_id = attributes[:'userId']
    
  
  end

  
  if attributes.has_key?(:'templateUri')
    
    
    self.template_uri = attributes[:'templateUri']
    
  
  end

  
  if attributes.has_key?(:'httpMethod')
    
    
    self.http_method = attributes[:'httpMethod']
    
  
  end

  
  if attributes.has_key?(:'status200')
    
    
    self.status200 = attributes[:'status200']
    
  
  end

  
  if attributes.has_key?(:'status300')
    
    
    self.status300 = attributes[:'status300']
    
  
  end

  
  if attributes.has_key?(:'status400')
    
    
    self.status400 = attributes[:'status400']
    
  
  end

  
  if attributes.has_key?(:'status500')
    
    
    self.status500 = attributes[:'status500']
    
  
  end

  
  if attributes.has_key?(:'status429')
    
    
    self.status429 = attributes[:'status429']
    
  
  end

  
  if attributes.has_key?(:'requests')
    
    
    self.requests = attributes[:'requests']
    
  
  end

  
  if attributes.has_key?(:'date')
    
    
    self.date = attributes[:'date']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 94
def self.swagger_types
  {
    
    :'client_id' => :'String',
    
    :'client_name' => :'String',
    
    :'organization_id' => :'String',
    
    :'user_id' => :'String',
    
    :'template_uri' => :'String',
    
    :'http_method' => :'String',
    
    :'status200' => :'Integer',
    
    :'status300' => :'Integer',
    
    :'status400' => :'Integer',
    
    :'status500' => :'Integer',
    
    :'status429' => :'Integer',
    
    :'requests' => :'Integer',
    
    :'date' => :'DateTime'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 389
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      client_name == o.client_name &&
      organization_id == o.organization_id &&
      user_id == o.user_id &&
      template_uri == o.template_uri &&
      http_method == o.http_method &&
      status200 == o.status200 &&
      status300 == o.status300 &&
      status400 == o.status400 &&
      status500 == o.status500 &&
      status429 == o.status429 &&
      requests == o.requests &&
      date == o.date
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 439
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
_to_hash(value) click to toggle source

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_row.rb, line 499
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_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 420
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 409
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 415
def hash
  [client_id, client_name, organization_id, user_id, template_uri, http_method, status200, status300, status400, status500, status429, requests, date].hash
end
list_invalid_properties() click to toggle source

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_row.rb, line 256
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 482
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 487
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
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/api_usage_row.rb, line 477
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_row.rb, line 265
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end