Class: AsposeEmailCloud::StorageFile

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

Overview

File or folder information

Direct Known Subclasses

FileVersion

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) ⇒ StorageFile

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.



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

def initialize(
  name: nil,
  is_folder: nil,
  modified_date: nil,
  size: nil,
  path: nil)
  self.name = name if name
  self.is_folder = is_folder if is_folder
  self.modified_date = modified_date if modified_date
  self.size = size if size
  self.path = path if path
end

Instance Attribute Details

#is_folder ⇒ BOOLEAN

True if it is a folder.

Returns:

  • (BOOLEAN) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 36

def is_folder
  @is_folder
end

#modified_date ⇒ DateTime

File or folder last modified DateTime.

Returns:

  • (DateTime) 


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

def modified_date
  @modified_date
end

#name ⇒ String

File or folder name.

Returns:

  • (String) 


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

def name
  @name
end

#path ⇒ String

File or folder path.

Returns:

  • (String) 


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

def path
  @path
end

#size ⇒ Integer

File or folder size.

Returns:

  • (Integer) 


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

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 47

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

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 58

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



112
113
114
115
116
117
118
119
120
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 112

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



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
194
195
196
197
198
199
200
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 160

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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 230

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 137

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


124
125
126
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 124

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 130

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



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 89

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

  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



210
211
212
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 210

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



216
217
218
219
220
221
222
223
224
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 216

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



204
205
206
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 204

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
107
108
 
# File 'lib/aspose-email-cloud/models/storage_file.rb', line 104

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