Class: GroupDocsConversionCloud::OtsConvertOptions
- Inherits:
-
Object
- Object
- GroupDocsConversionCloud::OtsConvertOptions
- Defined in:
- lib/groupdocs_conversion_cloud/models/ots_convert_options.rb
Overview
Ots convert options
Instance Attribute Summary collapse
-
#from_page ⇒ Object
Start conversion from FromPage page.
-
#pages ⇒ Object
Convert specific pages.
-
#pages_count ⇒ Object
Number of pages to convert.
-
#password ⇒ Object
Set this property if you want to protect the converted document with a password.
-
#use_pdf ⇒ Object
If true, the input firstly is converted to PDF and after that to desired format.
-
#watermark_options ⇒ Object
Watermark specific options.
-
#zoom ⇒ Object
Specifies the zoom level in percentage.
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 = {}) ⇒ OtsConvertOptions
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 = {}) ⇒ OtsConvertOptions
Initializes the object
83 84 85 86 87 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 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 83 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?(:'FromPage') self.from_page = attributes[:'FromPage'] end if attributes.key?(:'PagesCount') self.pages_count = attributes[:'PagesCount'] end if attributes.key?(:'Pages') if (value = attributes[:'Pages']).is_a?(Array) self.pages = value end end if attributes.key?(:'WatermarkOptions') self. = attributes[:'WatermarkOptions'] end if attributes.key?(:'Password') self.password = attributes[:'Password'] end if attributes.key?(:'Zoom') self.zoom = attributes[:'Zoom'] end if attributes.key?(:'UsePdf') self.use_pdf = attributes[:'UsePdf'] end end |
Instance Attribute Details
#from_page ⇒ Object
Start conversion from FromPage page
35 36 37 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 35 def from_page @from_page end |
#pages ⇒ Object
Convert specific pages. The list contains the page indexes of the pages to be converted
41 42 43 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 41 def pages @pages end |
#pages_count ⇒ Object
Number of pages to convert
38 39 40 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 38 def pages_count @pages_count end |
#password ⇒ Object
Set this property if you want to protect the converted document with a password
47 48 49 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 47 def password @password end |
#use_pdf ⇒ Object
If true, the input firstly is converted to PDF and after that to desired format
53 54 55 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 53 def use_pdf @use_pdf end |
#watermark_options ⇒ Object
Watermark specific options
44 45 46 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 44 def @watermark_options end |
#zoom ⇒ Object
Specifies the zoom level in percentage. Default is 100.
50 51 52 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 50 def zoom @zoom end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 56 def self.attribute_map { :'from_page' => :'FromPage', :'pages_count' => :'PagesCount', :'pages' => :'Pages', :'watermark_options' => :'WatermarkOptions', :'password' => :'Password', :'zoom' => :'Zoom', :'use_pdf' => :'UsePdf' } end |
.swagger_types ⇒ Object
Attribute type mapping.
69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 69 def self.swagger_types { :'from_page' => :'Integer', :'pages_count' => :'Integer', :'pages' => :'Array<Integer>', :'watermark_options' => :'WatermarkOptions', :'password' => :'String', :'zoom' => :'Integer', :'use_pdf' => :'BOOLEAN' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 156 def ==(other) return true if self.equal?(other) self.class == other.class && from_page == other.from_page && pages_count == other.pages_count && pages == other.pages && == other. && password == other.password && zoom == other.zoom && use_pdf == other.use_pdf end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
213 214 215 216 217 218 219 220 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 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 213 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
280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 280 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
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 189 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
170 171 172 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 170 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
176 177 178 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 176 def hash [from_page, pages_count, pages, , password, zoom, use_pdf].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 123 def list_invalid_properties invalid_properties = [] if @from_page.nil? invalid_properties.push("invalid value for 'from_page', from_page cannot be nil.") end if @pages_count.nil? invalid_properties.push("invalid value for 'pages_count', pages_count cannot be nil.") end if @zoom.nil? invalid_properties.push("invalid value for 'zoom', zoom cannot be nil.") end if @use_pdf.nil? invalid_properties.push("invalid value for 'use_pdf', use_pdf cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
260 261 262 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 260 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
266 267 268 269 270 271 272 273 274 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 266 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
254 255 256 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 254 def to_s to_hash.to_s end |
#uncap(str) ⇒ Object
Downcases first letter.
182 183 184 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 182 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
146 147 148 149 150 151 152 |
# File 'lib/groupdocs_conversion_cloud/models/ots_convert_options.rb', line 146 def valid? return false if @from_page.nil? return false if @pages_count.nil? return false if @zoom.nil? return false if @use_pdf.nil? return true end |