Class: AsposeWordsCloud::SearchResponse

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

Overview

The REST response with a regular expression pattern and a collection of search results. This response is returned by the Service when handling “GET api.aspose.cloud/v4.0/words/Test.doc/search” REST API requests.

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



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

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



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

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



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

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



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

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 



218
219
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 218

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


98
99
100
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 98

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [request_id, searching_pattern, search_results].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 184

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



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

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



178
179
180
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 178

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



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

def valid?
  return true
end

#validate ⇒ Object 



221
222
223
224
225
226
 
# File 'lib/aspose_words_cloud/models/search_response.rb', line 221

def validate()
  unless self.search_results.nil?
      self.search_results.validate
  end

end