Class: AsposeWordsCloud::SearchResponse

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

Overview

This response should be returned by the service when handling: GET api.aspose.cloud/v4.0/words/Test.doc/search.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'SearchingPattern')
    self.searching_pattern = attributes[:'SearchingPattern']
  end

  if attributes.key?(:'SearchResults')
    self.search_results = attributes[:'SearchResults']
  end
end

Instance Attribute Details

#request_id ⇒ Object

Gets or sets request Id.



34
35
36
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 34

def request_id
  @request_id
end

#search_results ⇒ Object

Gets or sets collection of search results.



40
41
42
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 40

def search_results
  @search_results
end

#searching_pattern ⇒ Object

Gets or sets a regular expression pattern used to find matches.



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

def searching_pattern
  @searching_pattern
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'request_id' => :'RequestId',
    :'searching_pattern' => :'SearchingPattern',
    :'search_results' => :'SearchResults'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'request_id' => :'String',
    :'searching_pattern' => :'String',
    :'search_results' => :'SearchResultsCollection'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



95
96
97
98
99
100
101
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 95

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      request_id == other.request_id &&
      searching_pattern == other.searching_pattern &&
      search_results == other.search_results
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



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

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
    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



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 207

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 118

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



111
112
113
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 111

def hash
  [request_id, searching_pattern, search_results].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



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

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



187
188
189
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 187

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



193
194
195
196
197
198
199
200
201
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 193

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



181
182
183
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 181

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



89
90
91
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 89

def valid?
  return true
end