Class: GroupDocsParserCloud::Image

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_parser_cloud/models/image.rb

Overview

Represents an image.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Image

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
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
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 78

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

  if attributes.key?(:'DownloadUrl')
    self.download_url = attributes[:'DownloadUrl']
  end

  if attributes.key?(:'PageIndex')
    self.page_index = attributes[:'PageIndex']
  end

  if attributes.key?(:'Rotation')
    self.rotation = attributes[:'Rotation']
  end

  if attributes.key?(:'FileFormat')
    self.file_format = attributes[:'FileFormat']
  end

  if attributes.key?(:'Rectangle')
    self.rectangle = attributes[:'Rectangle']
  end

end

Instance Attribute Details

#download_url ⇒ Object

Gets or sets the image download URL.



38
39
40
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 38

def download_url
  @download_url
end

#file_format ⇒ Object

Gets or sets the image file format.



47
48
49
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 47

def file_format
  @file_format
end

#page_index ⇒ Object

Gets or sets the index of the page.



41
42
43
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 41

def page_index
  @page_index
end

#path ⇒ Object

Gets or sets The path of the image, located in the storage.



35
36
37
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 35

def path
  @path
end

#rectangle ⇒ Object

Gets or sets the rectangle area of the image.



50
51
52
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 50

def rectangle
  @rectangle
end

#rotation ⇒ Object

Gets or sets the rotation of the image in degrees.



44
45
46
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 44

def rotation
  @rotation
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 53

def self.attribute_map
  {
    :'path' => :'Path',
    :'download_url' => :'DownloadUrl',
    :'page_index' => :'PageIndex',
    :'rotation' => :'Rotation',
    :'file_format' => :'FileFormat',
    :'rectangle' => :'Rectangle'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 65

def self.swagger_types
  {
    :'path' => :'String',
    :'download_url' => :'String',
    :'page_index' => :'Integer',
    :'rotation' => :'Float',
    :'file_format' => :'String',
    :'rectangle' => :'Rectangle'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 125

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      path == other.path &&
      download_url == other.download_url &&
      page_index == other.page_index &&
      rotation == other.rotation &&
      file_format == other.file_format &&
      rectangle == other.rectangle
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



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
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 181

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 248

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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 157

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


138
139
140
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 144

def hash
  [path, download_url, page_index, rotation, file_format, rectangle].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



112
113
114
115
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 112

def list_invalid_properties
  invalid_properties = []
  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



228
229
230
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 228

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



234
235
236
237
238
239
240
241
242
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 234

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



222
223
224
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 222

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



150
151
152
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 150

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

Returns:

  • (Boolean) —

    true if the model is valid



119
120
121
 
# File 'lib/groupdocs_parser_cloud/models/image.rb', line 119

def valid?
  return true
end