Class: CloudmersiveValidateApiClient::UserAgentValidateResponse
- Inherits:
-
Object
- Object
- CloudmersiveValidateApiClient::UserAgentValidateResponse
- Defined in:
- lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb
Overview
The result of a User-Agent validation request
Instance Attribute Summary collapse
-
#bot_name ⇒ Object
Optional; name of the robot if the request was from a known robot, otherwise null.
-
#bot_url ⇒ Object
Optional; if available, the URL to the robot.
-
#browser_engine_name ⇒ Object
Name of the Browser Engine.
-
#browser_engine_version ⇒ Object
Version of the Browser Engine.
-
#browser_name ⇒ Object
Name of the Browser.
-
#browser_version ⇒ Object
Version of the Browser.
-
#device_brand_name ⇒ Object
Brand name of the User-Agent.
-
#device_model ⇒ Object
Model name or number of the User-Agent.
-
#device_type ⇒ Object
Device type of the User-Agent; possible values are "DESKTOP", "SMARTPHONE", "TABLET".
-
#is_bot ⇒ Object
True if the request is a known robot, false otherwise.
-
#operating_system ⇒ Object
Operating System of the User-Agent (e.g. Windows).
-
#operating_system_cpu_platform ⇒ Object
The CPU platform of the User-Agent (e.g. x64).
-
#operating_system_version ⇒ Object
The version of the operating system of the User-Agent (e.g. "10" for Windows 10).
-
#successful ⇒ Object
True if the operation was successful, false otherwise.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ UserAgentValidateResponse
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ UserAgentValidateResponse
Initializes the object
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 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 164 165 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 103 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?(:'Successful') self.successful = attributes[:'Successful'] end if attributes.has_key?(:'IsBot') self.is_bot = attributes[:'IsBot'] end if attributes.has_key?(:'BotName') self.bot_name = attributes[:'BotName'] end if attributes.has_key?(:'BotURL') self.bot_url = attributes[:'BotURL'] end if attributes.has_key?(:'OperatingSystem') self. = attributes[:'OperatingSystem'] end if attributes.has_key?(:'OperatingSystemCPUPlatform') self. = attributes[:'OperatingSystemCPUPlatform'] end if attributes.has_key?(:'OperatingSystemVersion') self. = attributes[:'OperatingSystemVersion'] end if attributes.has_key?(:'DeviceType') self.device_type = attributes[:'DeviceType'] end if attributes.has_key?(:'DeviceBrandName') self.device_brand_name = attributes[:'DeviceBrandName'] end if attributes.has_key?(:'DeviceModel') self.device_model = attributes[:'DeviceModel'] end if attributes.has_key?(:'BrowserName') self.browser_name = attributes[:'BrowserName'] end if attributes.has_key?(:'BrowserVersion') self.browser_version = attributes[:'BrowserVersion'] end if attributes.has_key?(:'BrowserEngineName') self.browser_engine_name = attributes[:'BrowserEngineName'] end if attributes.has_key?(:'BrowserEngineVersion') self.browser_engine_version = attributes[:'BrowserEngineVersion'] end end |
Instance Attribute Details
#bot_name ⇒ Object
Optional; name of the robot if the request was from a known robot, otherwise null
25 26 27 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 25 def bot_name @bot_name end |
#bot_url ⇒ Object
Optional; if available, the URL to the robot
28 29 30 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 28 def bot_url @bot_url end |
#browser_engine_name ⇒ Object
Name of the Browser Engine
55 56 57 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 55 def browser_engine_name @browser_engine_name end |
#browser_engine_version ⇒ Object
Version of the Browser Engine
58 59 60 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 58 def browser_engine_version @browser_engine_version end |
#browser_name ⇒ Object
Name of the Browser
49 50 51 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 49 def browser_name @browser_name end |
#browser_version ⇒ Object
Version of the Browser
52 53 54 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 52 def browser_version @browser_version end |
#device_brand_name ⇒ Object
Brand name of the User-Agent
43 44 45 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 43 def device_brand_name @device_brand_name end |
#device_model ⇒ Object
Model name or number of the User-Agent
46 47 48 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 46 def device_model @device_model end |
#device_type ⇒ Object
Device type of the User-Agent; possible values are "DESKTOP", "SMARTPHONE", "TABLET"
40 41 42 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 40 def device_type @device_type end |
#is_bot ⇒ Object
True if the request is a known robot, false otherwise
22 23 24 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 22 def is_bot @is_bot end |
#operating_system ⇒ Object
Operating System of the User-Agent (e.g. Windows)
31 32 33 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 31 def @operating_system end |
#operating_system_cpu_platform ⇒ Object
The CPU platform of the User-Agent (e.g. x64)
34 35 36 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 34 def @operating_system_cpu_platform end |
#operating_system_version ⇒ Object
The version of the operating system of the User-Agent (e.g. "10" for Windows 10)
37 38 39 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 37 def @operating_system_version end |
#successful ⇒ Object
True if the operation was successful, false otherwise
19 20 21 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 19 def successful @successful end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 62 def self.attribute_map { :'successful' => :'Successful', :'is_bot' => :'IsBot', :'bot_name' => :'BotName', :'bot_url' => :'BotURL', :'operating_system' => :'OperatingSystem', :'operating_system_cpu_platform' => :'OperatingSystemCPUPlatform', :'operating_system_version' => :'OperatingSystemVersion', :'device_type' => :'DeviceType', :'device_brand_name' => :'DeviceBrandName', :'device_model' => :'DeviceModel', :'browser_name' => :'BrowserName', :'browser_version' => :'BrowserVersion', :'browser_engine_name' => :'BrowserEngineName', :'browser_engine_version' => :'BrowserEngineVersion' } end |
.swagger_types ⇒ Object
Attribute type mapping.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 82 def self.swagger_types { :'successful' => :'BOOLEAN', :'is_bot' => :'BOOLEAN', :'bot_name' => :'String', :'bot_url' => :'String', :'operating_system' => :'String', :'operating_system_cpu_platform' => :'String', :'operating_system_version' => :'String', :'device_type' => :'String', :'device_brand_name' => :'String', :'device_model' => :'String', :'browser_name' => :'String', :'browser_version' => :'String', :'browser_engine_name' => :'String', :'browser_engine_version' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 182 def ==(o) return true if self.equal?(o) self.class == o.class && successful == o.successful && is_bot == o.is_bot && bot_name == o.bot_name && bot_url == o.bot_url && == o. && == o. && == o. && device_type == o.device_type && device_brand_name == o.device_brand_name && device_model == o.device_model && browser_name == o.browser_name && browser_version == o.browser_version && browser_engine_name == o.browser_engine_name && browser_engine_version == o.browser_engine_version end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 237 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 =~ /\A(true|t|yes|y|1)\z/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 temp_model = CloudmersiveValidateApiClient.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 303 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
Builds the object from hash
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 216 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
203 204 205 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 203 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
209 210 211 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 209 def hash [successful, is_bot, bot_name, bot_url, , , , device_type, device_brand_name, device_model, browser_name, browser_version, browser_engine_name, browser_engine_version].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
169 170 171 172 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 169 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
283 284 285 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 283 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
289 290 291 292 293 294 295 296 297 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 289 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 ⇒ String
Returns the string representation of the object
277 278 279 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 277 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
176 177 178 |
# File 'lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb', line 176 def valid? return true end |