Class: Algolia::Search::ApiKey

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

Overview

API key object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
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
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
 
# File 'lib/algolia/models/search/api_key.rb', line 76

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::ApiKey` 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::ApiKey`. 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?(:acl)
    if (value = attributes[:acl]).is_a?(Array)
      self.acl = value
    end
  else
    self.acl = nil
  end

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

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

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

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

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

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

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

Instance Attribute Details

#acl ⇒ Object

Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint’s reference. For more information, see [access control list](www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).



11
12
13
 
# File 'lib/algolia/models/search/api_key.rb', line 11

def acl
  @acl
end

#description ⇒ Object

Description of an API key to help you identify this API key.



14
15
16
 
# File 'lib/algolia/models/search/api_key.rb', line 14

def description
  @description
end

#indexes ⇒ Object

Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (‘*`): - `dev_*` matches all indices starting with "dev_". - `*_dev` matches all indices ending with "_dev". - `products` matches all indices containing "products".



17
18
19
 
# File 'lib/algolia/models/search/api_key.rb', line 17

def indexes
  @indexes
end

#max_hits_per_query ⇒ Object

Maximum number of results this API key can retrieve in one query. By default, there’s no limit.



20
21
22
 
# File 'lib/algolia/models/search/api_key.rb', line 20

def max_hits_per_query
  @max_hits_per_query
end

#max_queries_per_ip_per_hour ⇒ Object

Maximum number of API requests allowed per IP address or [user token](www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour. If this limit is reached, the API returns an error with status code ‘429`. By default, there’s no limit.



23
24
25
 
# File 'lib/algolia/models/search/api_key.rb', line 23

def max_queries_per_ip_per_hour
  @max_queries_per_ip_per_hour
end

#query_parameters ⇒ Object

Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the ‘restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range.



26
27
28
 
# File 'lib/algolia/models/search/api_key.rb', line 26

def query_parameters
  @query_parameters
end

#referers ⇒ Object

Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (‘*`): - `algolia.com/*` allows all referrers starting with "algolia.com/" - `*.algolia.com` allows all referrers ending with ".algolia.com" - `algolia.com` allows all referrers in the domain "algolia.com". Like all HTTP headers, referrers can be spoofed. Don’t rely on them to secure your data. For more information, see [HTTP referrer restrictions](www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).



29
30
31
 
# File 'lib/algolia/models/search/api_key.rb', line 29

def referers
  @referers
end

#validity ⇒ Object

Duration (in seconds) after which the API key expires. By default, API keys don’t expire.



32
33
34
 
# File 'lib/algolia/models/search/api_key.rb', line 32

def validity
  @validity
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/algolia/models/search/api_key.rb', line 201

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



49
50
51
 
# File 'lib/algolia/models/search/api_key.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/algolia/models/search/api_key.rb', line 35

def self.attribute_map
  {
    :acl => :acl,
    :description => :description,
    :indexes => :indexes,
    :max_hits_per_query => :maxHitsPerQuery,
    :max_queries_per_ip_per_hour => :maxQueriesPerIPPerHour,
    :query_parameters => :queryParameters,
    :referers => :referers,
    :validity => :validity
  }
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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/algolia/models/search/api_key.rb', line 174

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



68
69
70
71
72
 
# File 'lib/algolia/models/search/api_key.rb', line 68

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

.types_mapping ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/algolia/models/search/api_key.rb', line 54

def self.types_mapping
  {
    :acl => :"Array<Acl>",
    :description => :"String",
    :indexes => :"Array<String>",
    :max_hits_per_query => :"Integer",
    :max_queries_per_ip_per_hour => :"Integer",
    :query_parameters => :"String",
    :referers => :"Array<String>",
    :validity => :"Integer"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/algolia/models/search/api_key.rb', line 137

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    acl == other.acl &&
    description == other.description &&
    indexes == other.indexes &&
    max_hits_per_query == other.max_hits_per_query &&
    max_queries_per_ip_per_hour == other.max_queries_per_ip_per_hour &&
    query_parameters == other.query_parameters &&
    referers == other.referers &&
    validity == other.validity
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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/algolia/models/search/api_key.rb', line 280

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


152
153
154
 
# File 'lib/algolia/models/search/api_key.rb', line 152

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/algolia/models/search/api_key.rb', line 158

def hash
  [
    acl,
    description,
    indexes,
    max_hits_per_query,
    max_queries_per_ip_per_hour,
    query_parameters,
    referers,
    validity
  ].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



251
252
253
 
# File 'lib/algolia/models/search/api_key.rb', line 251

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/algolia/models/search/api_key.rb', line 261

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 



255
256
257
 
# File 'lib/algolia/models/search/api_key.rb', line 255

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



245
246
247
 
# File 'lib/algolia/models/search/api_key.rb', line 245

def to_s
  to_hash.to_s
end