Class: PureCloud::AsyncQueryResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/async_query_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AsyncQueryResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 44

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?(:'jobId')
    
    
    self.job_id = attributes[:'jobId']
    
  
  end

  
end

Instance Attribute Details

#job_id ⇒ Object

Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 22

def job_id
  @job_id
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 25

def self.attribute_map
  {
    
    :'job_id' => :'jobId'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 34

def self.swagger_types
  {
    
    :'job_id' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 89

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      job_id == o.job_id
end

#_deserialize(type, value) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 127

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) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 187

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) ⇒ Object

build the object from hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 108

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


97
98
99
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 97

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



103
104
105
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 103

def hash
  [job_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



64
65
66
67
68
69
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 64

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



170
171
172
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 170

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



175
176
177
178
179
180
181
182
183
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 175

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 ⇒ Object 



165
166
167
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 165

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



73
74
75
76
77
78
79
 
# File 'lib/purecloudplatformclientv2/models/async_query_response.rb', line 73

def valid?
  
  
  
  
  
end