Class: CloudmersiveVirusScanApiClient::CloudStorageVirusScanResult

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

Overview

Result of running a virus scan on cloud storage

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CloudStorageVirusScanResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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_virus_scan_result.rb', line 62

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?(:'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?(:'ContainsContentModerationRejection')
    self.contains_content_moderation_rejection = attributes[:'ContainsContentModerationRejection']
  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_virus_scan_result.rb', line 22

def clean_result
  @clean_result
end

#contains_content_moderation_rejection ⇒ Object

Set to true when using NSFW Content Moderation in the Cloudmersive Storage Protect product (disabled by default)



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

def contains_content_moderation_rejection
  @contains_content_moderation_rejection
end

#error_detailed_description ⇒ Object

Detailed error message if the operation was not successful



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

def error_detailed_description
  @error_detailed_description
end

#file_size ⇒ Object

Size in bytes of the file that was retrieved and scanned



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

def file_size
  @file_size
end

#found_viruses ⇒ Object

Array of viruses found, if any



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

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_virus_scan_result.rb', line 19

def successful
  @successful
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 37

def self.attribute_map
  {
    :'successful' => :'Successful',
    :'clean_result' => :'CleanResult',
    :'found_viruses' => :'FoundViruses',
    :'error_detailed_description' => :'ErrorDetailedDescription',
    :'file_size' => :'FileSize',
    :'contains_content_moderation_rejection' => :'ContainsContentModerationRejection'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 49

def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'clean_result' => :'BOOLEAN',
    :'found_viruses' => :'Array<CloudStorageVirusFound>',
    :'error_detailed_description' => :'String',
    :'file_size' => :'Integer',
    :'contains_content_moderation_rejection' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      clean_result == o.clean_result &&
      found_viruses == o.found_viruses &&
      error_detailed_description == o.error_detailed_description &&
      file_size == o.file_size &&
      contains_content_moderation_rejection == o.contains_content_moderation_rejection
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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 157

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



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

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 136

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


123
124
125
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 123

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 129

def hash
  [successful, clean_result, found_viruses, error_detailed_description, file_size, contains_content_moderation_rejection].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



97
98
99
100
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 97

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



203
204
205
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 203

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



209
210
211
212
213
214
215
216
217
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 209

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



197
198
199
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 197

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



104
105
106
 
# File 'lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_scan_result.rb', line 104

def valid?
  true
end