Class: Algolia::Search::FetchedIndex

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/search/fetched_index.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FetchedIndex

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/algolia/models/search/fetched_index.rb', line 95

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::FetchedIndex` initialize method"
    )
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::FetchedIndex`. Please check the name to make sure it's valid. List of attributes: " +
          self.class.attribute_map.keys.inspect
      )
    end

    h[k.to_sym] = v
  }

  if attributes.key?(:name)
    self.name = attributes[:name]
  else
    self.name = nil
  end

  if attributes.key?(:created_at)
    self.created_at = attributes[:created_at]
  else
    self.created_at = nil
  end

  if attributes.key?(:updated_at)
    self.updated_at = attributes[:updated_at]
  else
    self.updated_at = nil
  end

  if attributes.key?(:entries)
    self.entries = attributes[:entries]
  else
    self.entries = nil
  end

  if attributes.key?(:data_size)
    self.data_size = attributes[:data_size]
  else
    self.data_size = nil
  end

  if attributes.key?(:file_size)
    self.file_size = attributes[:file_size]
  else
    self.file_size = nil
  end

  if attributes.key?(:last_build_time_s)
    self.last_build_time_s = attributes[:last_build_time_s]
  else
    self.last_build_time_s = nil
  end

  if attributes.key?(:number_of_pending_tasks)
    self.number_of_pending_tasks = attributes[:number_of_pending_tasks]
  else
    self.number_of_pending_tasks = nil
  end

  if attributes.key?(:pending_task)
    self.pending_task = attributes[:pending_task]
  else
    self.pending_task = nil
  end

  if attributes.key?(:primary)
    self.primary = attributes[:primary]
  end

  if attributes.key?(:replicas)
    if (value = attributes[:replicas]).is_a?(Array)
      self.replicas = value
    end
  end

  if attributes.key?(:virtual)
    self.virtual = attributes[:virtual]
  end
end

Instance Attribute Details

#created_at ⇒ Object

Index creation date. An empty string means that the index has no records.



13
14
15
 
# File 'lib/algolia/models/search/fetched_index.rb', line 13

def created_at
  @created_at
end

#data_size ⇒ Object

Number of bytes of the index in minified format.



22
23
24
 
# File 'lib/algolia/models/search/fetched_index.rb', line 22

def data_size
  @data_size
end

#entries ⇒ Object

Number of records contained in the index.



19
20
21
 
# File 'lib/algolia/models/search/fetched_index.rb', line 19

def entries
  @entries
end

#file_size ⇒ Object

Number of bytes of the index binary file.



25
26
27
 
# File 'lib/algolia/models/search/fetched_index.rb', line 25

def file_size
  @file_size
end

#last_build_time_s ⇒ Object

Last build time.



28
29
30
 
# File 'lib/algolia/models/search/fetched_index.rb', line 28

def last_build_time_s
  @last_build_time_s
end

#name ⇒ Object

Index name.



10
11
12
 
# File 'lib/algolia/models/search/fetched_index.rb', line 10

def name
  @name
end

#number_of_pending_tasks ⇒ Object

Number of pending indexing operations. This value is deprecated and should not be used.



31
32
33
 
# File 'lib/algolia/models/search/fetched_index.rb', line 31

def number_of_pending_tasks
  @number_of_pending_tasks
end

#pending_task ⇒ Object

A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.



34
35
36
 
# File 'lib/algolia/models/search/fetched_index.rb', line 34

def pending_task
  @pending_task
end

#primary ⇒ Object

Only present if the index is a replica. Contains the name of the related primary index.



37
38
39
 
# File 'lib/algolia/models/search/fetched_index.rb', line 37

def primary
  @primary
end

#replicas ⇒ Object

Only present if the index is a primary index with replicas. Contains the names of all linked replicas.



40
41
42
 
# File 'lib/algolia/models/search/fetched_index.rb', line 40

def replicas
  @replicas
end

#updated_at ⇒ Object

Date and time when the object was updated, in RFC 3339 format.



16
17
18
 
# File 'lib/algolia/models/search/fetched_index.rb', line 16

def updated_at
  @updated_at
end

#virtual ⇒ Object

Only present if the index is a [virtual replica](www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).



43
44
45
 
# File 'lib/algolia/models/search/fetched_index.rb', line 43

def virtual
  @virtual
end

Class Method Details

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/algolia/models/search/fetched_index.rb', line 259

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::Search.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
      .build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/algolia/models/search/fetched_index.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/algolia/models/search/fetched_index.rb', line 46

def self.attribute_map
  {
    :name => :name,
    :created_at => :createdAt,
    :updated_at => :updatedAt,
    :entries => :entries,
    :data_size => :dataSize,
    :file_size => :fileSize,
    :last_build_time_s => :lastBuildTimeS,
    :number_of_pending_tasks => :numberOfPendingTasks,
    :pending_task => :pendingTask,
    :primary => :primary,
    :replicas => :replicas,
    :virtual => :virtual
  }
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/algolia/models/search/fetched_index.rb', line 232

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end

  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
91
 
# File 'lib/algolia/models/search/fetched_index.rb', line 87

def self.openapi_nullable
  Set.new(
    []
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



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

def self.types_mapping
  {
    :name => :"String",
    :created_at => :"String",
    :updated_at => :"String",
    :entries => :"Integer",
    :data_size => :"Integer",
    :file_size => :"Integer",
    :last_build_time_s => :"Integer",
    :number_of_pending_tasks => :"Integer",
    :pending_task => :"Boolean",
    :primary => :"String",
    :replicas => :"Array<String>",
    :virtual => :"Boolean"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/algolia/models/search/fetched_index.rb', line 187

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    name == other.name &&
    created_at == other.created_at &&
    updated_at == other.updated_at &&
    entries == other.entries &&
    data_size == other.data_size &&
    file_size == other.file_size &&
    last_build_time_s == other.last_build_time_s &&
    number_of_pending_tasks == other.number_of_pending_tasks &&
    pending_task == other.pending_task &&
    primary == other.primary &&
    replicas == other.replicas &&
    virtual == other.virtual
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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/algolia/models/search/fetched_index.rb', line 338

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/algolia/models/search/fetched_index.rb', line 206

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/algolia/models/search/fetched_index.rb', line 212

def hash
  [
    name,
    created_at,
    updated_at,
    entries,
    data_size,
    file_size,
    last_build_time_s,
    number_of_pending_tasks,
    pending_task,
    primary,
    replicas,
    virtual
  ].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



309
310
311
 
# File 'lib/algolia/models/search/fetched_index.rb', line 309

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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/algolia/models/search/fetched_index.rb', line 319

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end

  hash
end

#to_json(*_args) ⇒ Object 



313
314
315
 
# File 'lib/algolia/models/search/fetched_index.rb', line 313

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



303
304
305
 
# File 'lib/algolia/models/search/fetched_index.rb', line 303

def to_s
  to_hash.to_s
end