Class: GroupDocsConversionCloud::J2kConvertOptions
- Inherits:
-
Object
- Object
- GroupDocsConversionCloud::J2kConvertOptions
- Defined in:
- lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb
Overview
J2k convert options
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#brightness ⇒ Object
Adjust image brightness.
-
#contrast ⇒ Object
Adjust image contrast.
-
#flip_mode ⇒ Object
Image flip mode.
-
#from_page ⇒ Object
Start conversion from FromPage page.
-
#gamma ⇒ Object
Adjust image gamma.
-
#grayscale ⇒ Object
Convert to grayscale image.
-
#height ⇒ Object
Desired image height after conversion.
-
#horizontal_resolution ⇒ Object
Desired image horizontal resolution after conversion.
-
#pages ⇒ Object
Convert specific pages.
-
#pages_count ⇒ Object
Number of pages to convert.
-
#quality ⇒ Object
Desired image quality when converting to Jpeg.
-
#rotate_angle ⇒ Object
Image rotation angle.
-
#use_pdf ⇒ Object
If true, the input firstly is converted to PDF and after that to desired format.
-
#vertical_resolution ⇒ Object
Desired image vertical resolution after conversion.
-
#watermark_options ⇒ Object
Watermark specific options.
-
#width ⇒ Object
Desired image width after conversion.
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 = {}) ⇒ J2kConvertOptions
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 = {}) ⇒ J2kConvertOptions
Initializes the object
149 150 151 152 153 154 155 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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 149 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?(:'Width') self.width = attributes[:'Width'] end if attributes.key?(:'Height') self.height = attributes[:'Height'] end if attributes.key?(:'HorizontalResolution') self.horizontal_resolution = attributes[:'HorizontalResolution'] end if attributes.key?(:'VerticalResolution') self.vertical_resolution = attributes[:'VerticalResolution'] end if attributes.key?(:'Grayscale') self.grayscale = attributes[:'Grayscale'] end if attributes.key?(:'RotateAngle') self.rotate_angle = attributes[:'RotateAngle'] end if attributes.key?(:'UsePdf') self.use_pdf = attributes[:'UsePdf'] end if attributes.key?(:'Brightness') self.brightness = attributes[:'Brightness'] end if attributes.key?(:'Contrast') self.contrast = attributes[:'Contrast'] end if attributes.key?(:'Gamma') self.gamma = attributes[:'Gamma'] end if attributes.key?(:'FlipMode') self.flip_mode = attributes[:'FlipMode'] end if attributes.key?(:'Quality') self.quality = attributes[:'Quality'] end end |
Instance Attribute Details
#brightness ⇒ Object
Adjust image brightness
68 69 70 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 68 def brightness @brightness end |
#contrast ⇒ Object
Adjust image contrast
71 72 73 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 71 def contrast @contrast end |
#flip_mode ⇒ Object
Image flip mode
77 78 79 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 77 def flip_mode @flip_mode end |
#from_page ⇒ Object
Start conversion from FromPage page
35 36 37 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 35 def from_page @from_page end |
#gamma ⇒ Object
Adjust image gamma
74 75 76 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 74 def gamma @gamma end |
#grayscale ⇒ Object
Convert to grayscale image
59 60 61 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 59 def grayscale @grayscale end |
#height ⇒ Object
Desired image height after conversion
50 51 52 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 50 def height @height end |
#horizontal_resolution ⇒ Object
Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96dpi
53 54 55 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 53 def horizontal_resolution @horizontal_resolution 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/j2k_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/j2k_convert_options.rb', line 38 def pages_count @pages_count end |
#quality ⇒ Object
Desired image quality when converting to Jpeg. The value must be between 0 and 100. The default value is 100.
80 81 82 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 80 def quality @quality end |
#rotate_angle ⇒ Object
Image rotation angle
62 63 64 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 62 def rotate_angle @rotate_angle end |
#use_pdf ⇒ Object
If true, the input firstly is converted to PDF and after that to desired format
65 66 67 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 65 def use_pdf @use_pdf end |
#vertical_resolution ⇒ Object
Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96dpi
56 57 58 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 56 def vertical_resolution @vertical_resolution end |
#watermark_options ⇒ Object
Watermark specific options
44 45 46 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 44 def @watermark_options end |
#width ⇒ Object
Desired image width after conversion
47 48 49 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 47 def width @width end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 104 def self.attribute_map { :'from_page' => :'FromPage', :'pages_count' => :'PagesCount', :'pages' => :'Pages', :'watermark_options' => :'WatermarkOptions', :'width' => :'Width', :'height' => :'Height', :'horizontal_resolution' => :'HorizontalResolution', :'vertical_resolution' => :'VerticalResolution', :'grayscale' => :'Grayscale', :'rotate_angle' => :'RotateAngle', :'use_pdf' => :'UsePdf', :'brightness' => :'Brightness', :'contrast' => :'Contrast', :'gamma' => :'Gamma', :'flip_mode' => :'FlipMode', :'quality' => :'Quality' } end |
.swagger_types ⇒ Object
Attribute type mapping.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 126 def self.swagger_types { :'from_page' => :'Integer', :'pages_count' => :'Integer', :'pages' => :'Array<Integer>', :'watermark_options' => :'WatermarkOptions', :'width' => :'Integer', :'height' => :'Integer', :'horizontal_resolution' => :'Integer', :'vertical_resolution' => :'Integer', :'grayscale' => :'BOOLEAN', :'rotate_angle' => :'Integer', :'use_pdf' => :'BOOLEAN', :'brightness' => :'Integer', :'contrast' => :'Integer', :'gamma' => :'Float', :'flip_mode' => :'String', :'quality' => :'Integer' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 324 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. && width == other.width && height == other.height && horizontal_resolution == other.horizontal_resolution && vertical_resolution == other.vertical_resolution && grayscale == other.grayscale && rotate_angle == other.rotate_angle && use_pdf == other.use_pdf && brightness == other.brightness && contrast == other.contrast && gamma == other.gamma && flip_mode == other.flip_mode && quality == other.quality end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 390 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
457 458 459 460 461 462 463 464 465 466 467 468 469 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 457 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
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 366 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
347 348 349 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 347 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
353 354 355 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 353 def hash [from_page, pages_count, pages, , width, height, horizontal_resolution, vertical_resolution, grayscale, rotate_angle, use_pdf, brightness, contrast, gamma, flip_mode, quality].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 225 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 @width.nil? invalid_properties.push("invalid value for 'width', width cannot be nil.") end if @height.nil? invalid_properties.push("invalid value for 'height', height cannot be nil.") end if @horizontal_resolution.nil? invalid_properties.push("invalid value for 'horizontal_resolution', horizontal_resolution cannot be nil.") end if @vertical_resolution.nil? invalid_properties.push("invalid value for 'vertical_resolution', vertical_resolution cannot be nil.") end if @grayscale.nil? invalid_properties.push("invalid value for 'grayscale', grayscale cannot be nil.") end if @rotate_angle.nil? invalid_properties.push("invalid value for 'rotate_angle', rotate_angle cannot be nil.") end if @use_pdf.nil? invalid_properties.push("invalid value for 'use_pdf', use_pdf cannot be nil.") end if @brightness.nil? invalid_properties.push("invalid value for 'brightness', brightness cannot be nil.") end if @contrast.nil? invalid_properties.push("invalid value for 'contrast', contrast cannot be nil.") end if @gamma.nil? invalid_properties.push("invalid value for 'gamma', gamma cannot be nil.") end if @flip_mode.nil? invalid_properties.push("invalid value for 'flip_mode', flip_mode cannot be nil.") end if @quality.nil? invalid_properties.push("invalid value for 'quality', quality cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
437 438 439 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 437 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
443 444 445 446 447 448 449 450 451 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 443 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
431 432 433 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 431 def to_s to_hash.to_s end |
#uncap(str) ⇒ Object
Downcases first letter.
359 360 361 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 359 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
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/groupdocs_conversion_cloud/models/j2k_convert_options.rb', line 288 def valid? return false if @from_page.nil? return false if @pages_count.nil? return false if @width.nil? return false if @height.nil? return false if @horizontal_resolution.nil? return false if @vertical_resolution.nil? return false if @grayscale.nil? return false if @rotate_angle.nil? return false if @use_pdf.nil? return false if @brightness.nil? return false if @contrast.nil? return false if @gamma.nil? return false if @flip_mode.nil? flip_mode_validator = EnumAttributeValidator.new('String', ["None", "FlipX", "FlipY", "FlipXY"]) return false unless flip_mode_validator.valid?(@flip_mode) return false if @quality.nil? return true end |