Class: GroupDocsConversionCloud::PersonalStorageLoadOptions
- Inherits:
-
Object
- Object
- GroupDocsConversionCloud::PersonalStorageLoadOptions
- Defined in:
- lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb
Overview
Options for loading personal storage documents.
Instance Attribute Summary collapse
-
#depth ⇒ Object
Controls how many levels in depth to perform conversion.
-
#folder ⇒ Object
Folder which to be processed Default is Inbox.
-
#format ⇒ Object
The format of input file, ("docx", for example).
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PersonalStorageLoadOptions
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#uncap(str) ⇒ Object
Downcases first letter.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PersonalStorageLoadOptions
Initializes the object
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 63 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.key?(:'Format') self.format = attributes[:'Format'] end if attributes.key?(:'Folder') self.folder = attributes[:'Folder'] end if attributes.key?(:'Depth') self.depth = attributes[:'Depth'] end end |
Instance Attribute Details
#depth ⇒ Object
Controls how many levels in depth to perform conversion
41 42 43 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 41 def depth @depth end |
#folder ⇒ Object
Folder which to be processed Default is Inbox
38 39 40 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 38 def folder @folder end |
#format ⇒ Object
The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
35 36 37 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 35 def format @format end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
44 45 46 47 48 49 50 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 44 def self.attribute_map { :'format' => :'Format', :'folder' => :'Folder', :'depth' => :'Depth' } end |
.swagger_types ⇒ Object
Attribute type mapping.
53 54 55 56 57 58 59 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 53 def self.swagger_types { :'format' => :'String', :'folder' => :'String', :'depth' => :'Integer' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
103 104 105 106 107 108 109 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 103 def ==(other) return true if self.equal?(other) self.class == other.class && format == other.format && folder == other.folder && depth == other.depth end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
156 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/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 156 def _deserialize(type, value) case type.to_sym when :DateTime Date.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 = GroupDocsConversionCloud.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
223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.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
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 132 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| pname = uncap(self.class.attribute_map[key]).intern value = attributes[pname] 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 value.is_a?(Array) self.send("#{key}=", value.map { |v| _deserialize($1, v) }) end elsif !value.nil? self.send("#{key}=", _deserialize(type, value)) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
113 114 115 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 113 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
119 120 121 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 119 def hash [format, folder, depth].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
85 86 87 88 89 90 91 92 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 85 def list_invalid_properties invalid_properties = [] if @depth.nil? invalid_properties.push("invalid value for 'depth', depth cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
203 204 205 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 203 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
209 210 211 212 213 214 215 216 217 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.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
197 198 199 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 197 def to_s to_hash.to_s end |
#uncap(str) ⇒ Object
Downcases first letter.
125 126 127 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 125 def uncap(str) str[0, 1].downcase + str[1..-1] end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
96 97 98 99 |
# File 'lib/groupdocs_conversion_cloud/models/personal_storage_load_options.rb', line 96 def valid? return false if @depth.nil? return true end |