Class: CloudmersiveVirusScanApiClient::CloudStorageAdvancedVirusScanResult

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

Overview

Result of running an advanced virus scan on cloud storage

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CloudStorageAdvancedVirusScanResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
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
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#clean_result ⇒ Object

True if the scan contained no viruses, false otherwise



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

def clean_result
  @clean_result
end

#contains_executable ⇒ Object

True if the scan contained an executable (application code), which can be a significant risk factor



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

def contains_executable
  @contains_executable
end

#contains_invalid_file ⇒ Object

True if the scan contained an invalid file (such as a PDF that is not a valid PDF, Word Document that is not a valid Word Document, etc.), which can be a significant risk factor



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

def contains_invalid_file
  @contains_invalid_file
end

#contains_macros ⇒ Object

True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor



40
41
42
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 40

def contains_macros
  @contains_macros
end

#contains_password_protected_file ⇒ Object

True if the scan contained a password protected or encrypted file, which can be a significant risk factor



34
35
36
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 34

def contains_password_protected_file
  @contains_password_protected_file
end

#contains_restricted_file_format ⇒ Object

True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false



37
38
39
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 37

def contains_restricted_file_format
  @contains_restricted_file_format
end

#contains_script ⇒ Object

True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor



31
32
33
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 31

def contains_script
  @contains_script
end

#content_information ⇒ Object

Contains additional non-threat content verification information



55
56
57
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 55

def content_information
  @content_information
end

#error_detailed_description ⇒ Object

Detailed error message if the operation was not successful



49
50
51
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 49

def error_detailed_description
  @error_detailed_description
end

#file_size ⇒ Object

Size in bytes of the file that was retrieved and scanned



52
53
54
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 52

def file_size
  @file_size
end

#found_viruses ⇒ Object

Array of viruses found, if any



46
47
48
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 46

def found_viruses
  @found_viruses
end

#successful ⇒ Object

True if the operation of retrieving the file, and scanning it were successfully completed, false if the file could not be downloaded from cloud storage, or if the file could not be scanned. Note that successful completion does not mean the file is clean; for the output of the virus scanning operation itself, use the CleanResult and FoundViruses parameters.



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

def successful
  @successful
end

#verified_file_format ⇒ Object

For file format verification-supported file formats, the contents-verified file format of the file. Null indicates that the file format is not supported for contents verification. If a Virus or Malware is found, this field will always be set to Null.



43
44
45
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 43

def verified_file_format
  @verified_file_format
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 58

def self.attribute_map
  {
    :'successful' => :'Successful',
    :'clean_result' => :'CleanResult',
    :'contains_executable' => :'ContainsExecutable',
    :'contains_invalid_file' => :'ContainsInvalidFile',
    :'contains_script' => :'ContainsScript',
    :'contains_password_protected_file' => :'ContainsPasswordProtectedFile',
    :'contains_restricted_file_format' => :'ContainsRestrictedFileFormat',
    :'contains_macros' => :'ContainsMacros',
    :'verified_file_format' => :'VerifiedFileFormat',
    :'found_viruses' => :'FoundViruses',
    :'error_detailed_description' => :'ErrorDetailedDescription',
    :'file_size' => :'FileSize',
    :'content_information' => :'ContentInformation'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 77

def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'clean_result' => :'BOOLEAN',
    :'contains_executable' => :'BOOLEAN',
    :'contains_invalid_file' => :'BOOLEAN',
    :'contains_script' => :'BOOLEAN',
    :'contains_password_protected_file' => :'BOOLEAN',
    :'contains_restricted_file_format' => :'BOOLEAN',
    :'contains_macros' => :'BOOLEAN',
    :'verified_file_format' => :'String',
    :'found_viruses' => :'Array<CloudStorageVirusFound>',
    :'error_detailed_description' => :'String',
    :'file_size' => :'Integer',
    :'content_information' => :'AdditionalAdvancedScanInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      clean_result == o.clean_result &&
      contains_executable == o.contains_executable &&
      contains_invalid_file == o.contains_invalid_file &&
      contains_script == o.contains_script &&
      contains_password_protected_file == o.contains_password_protected_file &&
      contains_restricted_file_format == o.contains_restricted_file_format &&
      contains_macros == o.contains_macros &&
      verified_file_format == o.verified_file_format &&
      found_viruses == o.found_viruses &&
      error_detailed_description == o.error_detailed_description &&
      file_size == o.file_size &&
      content_information == o.content_information
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



227
228
229
230
231
232
233
234
235
236
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
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 227

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 293

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 206

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


193
194
195
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 199

def hash
  [successful, clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, verified_file_format, found_viruses, error_detailed_description, file_size, content_information].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



160
161
162
163
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 160

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



273
274
275
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 273

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



279
280
281
282
283
284
285
286
287
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 279

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



267
268
269
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 267

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



167
168
169
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb', line 167

def valid?
  true
end