Class: AsposeEmailCloud::FileVersion

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/file_version.rb

Overview

File Version

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = nil, is_folder = nil, modified_date = nil, size = nil, path = nil, version_id = nil, is_latest = nil) ⇒ FileVersion

Initializes the object

Parameters:

  • name (String) (defaults to: nil) —

    File or folder name.

  • is_folder (BOOLEAN) (defaults to: nil) —

    True if it is a folder.

  • modified_date (DateTime) (defaults to: nil) —

    File or folder last modified DateTime.

  • size (Integer) (defaults to: nil) —

    File or folder size.

  • path (String) (defaults to: nil) —

    File or folder path.

  • version_id (String) (defaults to: nil) —

    File Version ID.

  • is_latest (BOOLEAN) (defaults to: nil) —

    Specifies whether the file is (true) or is not (false) the latest version of an file.



88
89
90
91
92
93
94
95
96
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
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 88

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

  if attributes.has_key?(:'isFolder')
    self.is_folder = attributes[:'isFolder']
  end

  if attributes.has_key?(:'modifiedDate')
    self.modified_date = attributes[:'modifiedDate']
  end

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

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

  if attributes.has_key?(:'versionId')
    self.version_id = attributes[:'versionId']
  end

  if attributes.has_key?(:'isLatest')
    self.is_latest = attributes[:'isLatest']
  end
end

Instance Attribute Details

#is_folder ⇒ BOOLEAN

True if it is a folder.

Returns:

  • (BOOLEAN) 


38
39
40
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 38

def is_folder
  @is_folder
end

#is_latest ⇒ BOOLEAN

Specifies whether the file is (true) or is not (false) the latest version of an file.

Returns:

  • (BOOLEAN) 


58
59
60
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 58

def is_latest
  @is_latest
end

#modified_date ⇒ DateTime

File or folder last modified DateTime.

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 42

def modified_date
  @modified_date
end

#name ⇒ String

File or folder name.

Returns:

  • (String) 


34
35
36
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 34

def name
  @name
end

#path ⇒ String

File or folder path.

Returns:

  • (String) 


50
51
52
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 50

def path
  @path
end

#size ⇒ Integer

File or folder size.

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 46

def size
  @size
end

#version_id ⇒ String

File Version ID.

Returns:

  • (String) 


54
55
56
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 54

def version_id
  @version_id
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 61

def self.attribute_map
  {
    :'name' => :'name',
    :'is_folder' => :'isFolder',
    :'modified_date' => :'modifiedDate',
    :'size' => :'size',
    :'path' => :'path',
    :'version_id' => :'versionId',
    :'is_latest' => :'isLatest'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 74

def self.swagger_types
  {
    :'name' => :'String',
    :'is_folder' => :'BOOLEAN',
    :'modified_date' => :'DateTime',
    :'size' => :'Integer',
    :'path' => :'String',
    :'version_id' => :'String',
    :'is_latest' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      is_folder == o.is_folder &&
      modified_date == o.modified_date &&
      size == o.size &&
      path == o.path &&
      version_id == o.version_id &&
      is_latest == o.is_latest
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



221
222
223
224
225
226
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
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 221

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

    type = value[:type] || type
    temp_model = AsposeEmailCloud.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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 288

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 198

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    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[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_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


185
186
187
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 191

def hash
  [name, is_folder, modified_date, size, path, version_id, is_latest].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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 143

def list_invalid_properties
  invalid_properties = Array.new
  if @is_folder.nil?
    invalid_properties.push('invalid value for "is_folder", is_folder cannot be nil.')
  end

  if @size.nil?
    invalid_properties.push('invalid value for "size", size cannot be nil.')
  end

  if @is_latest.nil?
    invalid_properties.push('invalid value for "is_latest", is_latest cannot be nil.')
  end

  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



268
269
270
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 268

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



274
275
276
277
278
279
280
281
282
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 274

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



262
263
264
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 262

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



162
163
164
165
166
167
 
# File 'lib/aspose-email-cloud/models/file_version.rb', line 162

def valid?
  return false if @is_folder.nil?
  return false if @size.nil?
  return false if @is_latest.nil?
  true
end