Class: AsposePdfCloud::OptimizeOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/optimize_options.rb

Overview

Represents Pdf optimize options.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OptimizeOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
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
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 108

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?(:'AllowReusePageContent')
    self.allow_reuse_page_content = attributes[:'AllowReusePageContent']
  end

  if attributes.has_key?(:'CompressImages')
    self.compress_images = attributes[:'CompressImages']
  end

  if attributes.has_key?(:'ImageQuality')
    self.image_quality = attributes[:'ImageQuality']
  end

  if attributes.has_key?(:'LinkDuplcateStreams')
    self.link_duplcate_streams = attributes[:'LinkDuplcateStreams']
  end

  if attributes.has_key?(:'RemoveUnusedObjects')
    self.remove_unused_objects = attributes[:'RemoveUnusedObjects']
  end

  if attributes.has_key?(:'RemoveUnusedStreams')
    self.remove_unused_streams = attributes[:'RemoveUnusedStreams']
  end

  if attributes.has_key?(:'UnembedFonts')
    self.unembed_fonts = attributes[:'UnembedFonts']
  end

  if attributes.has_key?(:'ResizeImages')
    self.resize_images = attributes[:'ResizeImages']
  end

  if attributes.has_key?(:'MaxResolution')
    self.max_resolution = attributes[:'MaxResolution']
  end

  if attributes.has_key?(:'SubsetFonts')
    self.subset_fonts = attributes[:'SubsetFonts']
  end

  if attributes.has_key?(:'RemovePrivateInfo')
    self.remove_private_info = attributes[:'RemovePrivateInfo']
  end

  if attributes.has_key?(:'ImageEncoding')
    self.image_encoding = attributes[:'ImageEncoding']
  end

  if attributes.has_key?(:'ImageCompressionVersion')
    self.image_compression_version = attributes[:'ImageCompressionVersion']
  end

end

Instance Attribute Details

#allow_reuse_page_content ⇒ Object

If true page contents will be reused when document is optimized for equal pages.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 29

def allow_reuse_page_content
  @allow_reuse_page_content
end

#compress_images ⇒ Object

If this flag is set to true images will be compressed in the document. Compression level is specified with ImageQuality property.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 32

def compress_images
  @compress_images
end

#image_compression_version ⇒ Object

Version of compression algorithm. Possible values are: "Standard" - standard compression, "Fast" - fast (improved compression which is faster then standard but may be applicable not for all images), "Mixed" - mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then "Fast" algorithm. Version "Fast" is not applicable for resizing images (standard method will be used). Default is "Standard".



65
66
67
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 65

def image_compression_version
  @image_compression_version
end

#image_encoding ⇒ Object

Image encode which will be used.



62
63
64
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 62

def image_encoding
  @image_encoding
end

#image_quality ⇒ Object

Specifies level of image compression when CompressImages flag is used.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 35

def image_quality
  @image_quality
end

#link_duplcate_streams ⇒ Object

If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thees streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenated multiple times).



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 38

def link_duplcate_streams
  @link_duplcate_streams
end

#max_resolution ⇒ Object

Specifies maximum resolution of images. If image has higher resolution it will be scaled.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 53

def max_resolution
  @max_resolution
end

#remove_private_info ⇒ Object

Remove private information (page piece info).



59
60
61
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 59

def remove_private_info
  @remove_private_info
end

#remove_unused_objects ⇒ Object

If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 41

def remove_unused_objects
  @remove_unused_objects
end

#remove_unused_streams ⇒ Object

If this flag set to true, every resource is checked on it’s usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 44

def remove_unused_streams
  @remove_unused_streams
end

#resize_images ⇒ Object

If this flag set to true and CompressImages is true images will be resized if image resolution is greater then specified MaxResolution parameter.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 50

def resize_images
  @resize_images
end

#subset_fonts ⇒ Object

Fonts will be converted into subsets if set to true.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 56

def subset_fonts
  @subset_fonts
end

#unembed_fonts ⇒ Object

Make fonts not embedded if set to true.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 47

def unembed_fonts
  @unembed_fonts
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 69

def self.attribute_map
  {
    :'allow_reuse_page_content' => :'AllowReusePageContent',
    :'compress_images' => :'CompressImages',
    :'image_quality' => :'ImageQuality',
    :'link_duplcate_streams' => :'LinkDuplcateStreams',
    :'remove_unused_objects' => :'RemoveUnusedObjects',
    :'remove_unused_streams' => :'RemoveUnusedStreams',
    :'unembed_fonts' => :'UnembedFonts',
    :'resize_images' => :'ResizeImages',
    :'max_resolution' => :'MaxResolution',
    :'subset_fonts' => :'SubsetFonts',
    :'remove_private_info' => :'RemovePrivateInfo',
    :'image_encoding' => :'ImageEncoding',
    :'image_compression_version' => :'ImageCompressionVersion'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 88

def self.swagger_types
  {
    :'allow_reuse_page_content' => :'BOOLEAN',
    :'compress_images' => :'BOOLEAN',
    :'image_quality' => :'Integer',
    :'link_duplcate_streams' => :'BOOLEAN',
    :'remove_unused_objects' => :'BOOLEAN',
    :'remove_unused_streams' => :'BOOLEAN',
    :'unembed_fonts' => :'BOOLEAN',
    :'resize_images' => :'BOOLEAN',
    :'max_resolution' => :'Integer',
    :'subset_fonts' => :'BOOLEAN',
    :'remove_private_info' => :'BOOLEAN',
    :'image_encoding' => :'ImageEncoding',
    :'image_compression_version' => :'ImageCompressionVersion'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_reuse_page_content == o.allow_reuse_page_content &&
      compress_images == o.compress_images &&
      image_quality == o.image_quality &&
      link_duplcate_streams == o.link_duplcate_streams &&
      remove_unused_objects == o.remove_unused_objects &&
      remove_unused_streams == o.remove_unused_streams &&
      unembed_fonts == o.unembed_fonts &&
      resize_images == o.resize_images &&
      max_resolution == o.max_resolution &&
      subset_fonts == o.subset_fonts &&
      remove_private_info == o.remove_private_info &&
      image_encoding == o.image_encoding &&
      image_compression_version == o.image_compression_version
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



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
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 237

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 = AsposePdfCloud.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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 303

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 216

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



209
210
211
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 209

def hash
  [allow_reuse_page_content, compress_images, image_quality, link_duplcate_streams, remove_unused_objects, remove_unused_streams, unembed_fonts, resize_images, max_resolution, subset_fonts, remove_private_info, image_encoding, image_compression_version].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



170
171
172
173
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 170

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 283

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



289
290
291
292
293
294
295
296
297
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 289

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



277
278
279
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 277

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



177
178
179
 
# File 'lib/aspose_pdf_cloud/models/optimize_options.rb', line 177

def valid?
  return true
end