Class: CloudmersiveVirusScanApiClient::WebsiteScanResult

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb

Overview

Result of running a website scan

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebsiteScanResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 74

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

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

  if attributes.has_key?(:'FoundViruses')
    if (value = attributes[:'FoundViruses']).is_a?(Array)
      self.found_viruses = value
    end
  end

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

Instance Attribute Details

#clean_result ⇒ Object

True if the scan contained no threats, false otherwise



19
20
21
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 19

def clean_result
  @clean_result
end

#found_viruses ⇒ Object

Array of viruses found, if any



25
26
27
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 25

def found_viruses
  @found_viruses
end

#website_http_response_code ⇒ Object

The remote server URL HTTP reasponse code; useful for debugging issues with scanning; typically if the remote server returns a 200 or 300-series code this means a successful response, while a 400 or 500 series code would represent an error returned from the remote server for the provided URL.



28
29
30
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 28

def website_http_response_code
  @website_http_response_code
end

#website_threat_type ⇒ Object

Type of threat returned; can be None, Malware, ForcedDownload or Phishing



22
23
24
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 22

def website_threat_type
  @website_threat_type
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 53

def self.attribute_map
  {
    :'clean_result' => :'CleanResult',
    :'website_threat_type' => :'WebsiteThreatType',
    :'found_viruses' => :'FoundViruses',
    :'website_http_response_code' => :'WebsiteHttpResponseCode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 63

def self.swagger_types
  {
    :'clean_result' => :'BOOLEAN',
    :'website_threat_type' => :'String',
    :'found_viruses' => :'Array<VirusFound>',
    :'website_http_response_code' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      clean_result == o.clean_result &&
      website_threat_type == o.website_threat_type &&
      found_viruses == o.found_viruses &&
      website_http_response_code == o.website_http_response_code
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 171

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 = CloudmersiveVirusScanApiClient.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 237

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 150

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


137
138
139
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 137

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 143

def hash
  [clean_result, website_threat_type, found_viruses, website_http_response_code].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



101
102
103
104
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 217

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 223

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

Returns:

  • (String) —

    String presentation of the object



211
212
213
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 211

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



108
109
110
111
112
 
# File 'lib/cloudmersive-virus-scan-api-client/models/website_scan_result.rb', line 108

def valid?
  website_threat_type_validator = EnumAttributeValidator.new('String', ['None', 'Malware', 'Phishing', 'ForcedDownload', 'UnableToConnect'])
  return false unless website_threat_type_validator.valid?(@website_threat_type)
  true
end