Class: AsposeWordsCloud::CustomXmlPart

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/custom_xml_part.rb

Overview

DTO container with a CustomXmlPart.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomXmlPart

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 62

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

  if attributes.key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.key?(:'Data')
    self.data = attributes[:'Data']
  end
end

Instance Attribute Details

#dataObject

Gets or sets the custom xml part data. Cannot be null.Default is empty string.



41
42
43
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 41

def data
  @data
end

#idObject

Gets or sets the custom xml part id. Cannot be null.



37
38
39
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 37

def id
  @id
end

Gets or sets the link to the document.



33
34
35
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 33

def link
  @link
end

Class Method Details

.attribute_mapObject

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



43
44
45
46
47
48
49
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 43

def self.attribute_map
  {
    :'link' => :'Link',
    :'id' => :'Id',
    :'data' => :'Data'
  }
end

.swagger_typesObject

Attribute type mapping.



52
53
54
55
56
57
58
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 52

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'id' => :'String',
    :'data' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



89
90
91
92
93
94
95
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 89

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      id == other.id &&
      data == other.data
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



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
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 134

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 205

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 112

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

#collectFilesContent(resultFilesContent) ⇒ Object



219
220
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 219

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


99
100
101
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 99

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



105
106
107
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 105

def hash
  [link, id, data].hash
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



185
186
187
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 185

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 191

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



179
180
181
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 179

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



83
84
85
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 83

def valid?
  return true
end

#validateObject

Raises:

  • (ArgumentError)


222
223
224
225
226
227
228
# File 'lib/aspose_words_cloud/models/custom_xml_part.rb', line 222

def validate()
  raise ArgumentError, 'Property data in CustomXmlPart is required.' if self.data.nil?
  unless self.link.nil?
      self.link.validate
  end

end