Class: CloudmersiveConvertApiClient::GetImageInfoResult
- Inherits:
-
Object
- Object
- CloudmersiveConvertApiClient::GetImageInfoResult
- Defined in:
- lib/cloudmersive-convert-api-client/models/get_image_info_result.rb
Overview
Result of running a get-info operation on an image
Instance Attribute Summary collapse
-
#bit_depth ⇒ Object
Bit depth of the image.
-
#color_count ⇒ Object
Unique colors in the image.
-
#color_space ⇒ Object
Color space of the image.
-
#color_type ⇒ Object
Color type of the image.
-
#comment ⇒ Object
Comment string in the image.
-
#compression_level ⇒ Object
Compression level value from 0 (lowest quality) to 100 (highest quality).
-
#dpi ⇒ Object
DPI (pixels per unit, e.g. pixels per inch) of the image.
-
#dpi_unit ⇒ Object
Units of the DPI measurement; can be either in Inches or Centimeters.
-
#exif_profile_name ⇒ Object
Name of the EXIF profile used.
-
#exif_values ⇒ Object
EXIF tags and values embedded in the image.
-
#has_transparency ⇒ Object
True if the image contains transparency, otherwise false.
-
#height ⇒ Object
Height in pixels of the image.
-
#image_format ⇒ Object
Image format.
-
#image_hash_signature ⇒ Object
SHA256 hash signature of the image.
-
#mime_type ⇒ Object
MIME type of the image format.
-
#successful ⇒ Object
Returns the value of attribute successful.
-
#width ⇒ Object
Width in pixels of the image.
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
-
#==(o) ⇒ 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?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ GetImageInfoResult
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.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ GetImageInfoResult
Initializes the object
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 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 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 117 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?(:'Successful') self.successful = attributes[:'Successful'] end if attributes.has_key?(:'ColorSpace') self.color_space = attributes[:'ColorSpace'] end if attributes.has_key?(:'ColorType') self.color_type = attributes[:'ColorType'] end if attributes.has_key?(:'Width') self.width = attributes[:'Width'] end if attributes.has_key?(:'Height') self.height = attributes[:'Height'] end if attributes.has_key?(:'CompressionLevel') self.compression_level = attributes[:'CompressionLevel'] end if attributes.has_key?(:'ImageHashSignature') self.image_hash_signature = attributes[:'ImageHashSignature'] end if attributes.has_key?(:'HasTransparency') self.has_transparency = attributes[:'HasTransparency'] end if attributes.has_key?(:'MimeType') self.mime_type = attributes[:'MimeType'] end if attributes.has_key?(:'ImageFormat') self.image_format = attributes[:'ImageFormat'] end if attributes.has_key?(:'DPIUnit') self.dpi_unit = attributes[:'DPIUnit'] end if attributes.has_key?(:'DPI') self.dpi = attributes[:'DPI'] end if attributes.has_key?(:'ColorCount') self.color_count = attributes[:'ColorCount'] end if attributes.has_key?(:'BitDepth') self.bit_depth = attributes[:'BitDepth'] end if attributes.has_key?(:'Comment') self.comment = attributes[:'Comment'] end if attributes.has_key?(:'ExifProfileName') self.exif_profile_name = attributes[:'ExifProfileName'] end if attributes.has_key?(:'ExifValues') if (value = attributes[:'ExifValues']).is_a?(Array) self.exif_values = value end end end |
Instance Attribute Details
#bit_depth ⇒ Object
Bit depth of the image
57 58 59 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 57 def bit_depth @bit_depth end |
#color_count ⇒ Object
Unique colors in the image
54 55 56 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 54 def color_count @color_count end |
#color_space ⇒ Object
Color space of the image
21 22 23 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 21 def color_space @color_space end |
#color_type ⇒ Object
Color type of the image
24 25 26 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 24 def color_type @color_type end |
#comment ⇒ Object
Comment string in the image
60 61 62 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 60 def comment @comment end |
#compression_level ⇒ Object
Compression level value from 0 (lowest quality) to 100 (highest quality)
33 34 35 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 33 def compression_level @compression_level end |
#dpi ⇒ Object
DPI (pixels per unit, e.g. pixels per inch) of the image
51 52 53 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 51 def dpi @dpi end |
#dpi_unit ⇒ Object
Units of the DPI measurement; can be either in Inches or Centimeters
48 49 50 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 48 def dpi_unit @dpi_unit end |
#exif_profile_name ⇒ Object
Name of the EXIF profile used
63 64 65 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 63 def exif_profile_name @exif_profile_name end |
#exif_values ⇒ Object
EXIF tags and values embedded in the image
66 67 68 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 66 def exif_values @exif_values end |
#has_transparency ⇒ Object
True if the image contains transparency, otherwise false
39 40 41 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 39 def has_transparency @has_transparency end |
#height ⇒ Object
Height in pixels of the image
30 31 32 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 30 def height @height end |
#image_format ⇒ Object
Image format
45 46 47 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 45 def image_format @image_format end |
#image_hash_signature ⇒ Object
SHA256 hash signature of the image
36 37 38 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 36 def image_hash_signature @image_hash_signature end |
#mime_type ⇒ Object
MIME type of the image format
42 43 44 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 42 def mime_type @mime_type end |
#successful ⇒ Object
Returns the value of attribute successful.
18 19 20 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 18 def successful @successful end |
#width ⇒ Object
Width in pixels of the image
27 28 29 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 27 def width @width end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 70 def self.attribute_map { :'successful' => :'Successful', :'color_space' => :'ColorSpace', :'color_type' => :'ColorType', :'width' => :'Width', :'height' => :'Height', :'compression_level' => :'CompressionLevel', :'image_hash_signature' => :'ImageHashSignature', :'has_transparency' => :'HasTransparency', :'mime_type' => :'MimeType', :'image_format' => :'ImageFormat', :'dpi_unit' => :'DPIUnit', :'dpi' => :'DPI', :'color_count' => :'ColorCount', :'bit_depth' => :'BitDepth', :'comment' => :'Comment', :'exif_profile_name' => :'ExifProfileName', :'exif_values' => :'ExifValues' } end |
.swagger_types ⇒ Object
Attribute type mapping.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 93 def self.swagger_types { :'successful' => :'BOOLEAN', :'color_space' => :'String', :'color_type' => :'String', :'width' => :'Integer', :'height' => :'Integer', :'compression_level' => :'Integer', :'image_hash_signature' => :'String', :'has_transparency' => :'BOOLEAN', :'mime_type' => :'String', :'image_format' => :'String', :'dpi_unit' => :'String', :'dpi' => :'Float', :'color_count' => :'Integer', :'bit_depth' => :'Integer', :'comment' => :'String', :'exif_profile_name' => :'String', :'exif_values' => :'Array<ExifValue>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 210 def ==(o) return true if self.equal?(o) self.class == o.class && successful == o.successful && color_space == o.color_space && color_type == o.color_type && width == o.width && height == o.height && compression_level == o.compression_level && image_hash_signature == o.image_hash_signature && has_transparency == o.has_transparency && mime_type == o.mime_type && image_format == o.image_format && dpi_unit == o.dpi_unit && dpi == o.dpi && color_count == o.color_count && bit_depth == o.bit_depth && comment == o.comment && exif_profile_name == o.exif_profile_name && exif_values == o.exif_values end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 268 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 temp_model = CloudmersiveConvertApiClient.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
334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 334 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
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 247 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| 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[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[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
234 235 236 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 234 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
240 241 242 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 240 def hash [successful, color_space, color_type, width, height, compression_level, image_hash_signature, has_transparency, mime_type, image_format, dpi_unit, dpi, color_count, bit_depth, comment, exif_profile_name, exif_values].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
197 198 199 200 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 197 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
314 315 316 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 314 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
320 321 322 323 324 325 326 327 328 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 320 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
308 309 310 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 308 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
204 205 206 |
# File 'lib/cloudmersive-convert-api-client/models/get_image_info_result.rb', line 204 def valid? return true end |