Class: Algolia::Search::SecuredApiKeyRestrictions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecuredApiKeyRestrictions

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

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

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

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

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

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

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

Instance Attribute Details

#filters ⇒ Object

Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with ‘AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.



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

def filters
  @filters
end

#restrict_indices ⇒ 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".



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

def restrict_indices
  @restrict_indices
end

#restrict_sources ⇒ Object

IP network that are allowed to use this key. You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.



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

def restrict_sources
  @restrict_sources
end

#search_params ⇒ Object

Returns the value of attribute search_params.



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

def search_params
  @search_params
end

#user_token ⇒ Object

Pseudonymous user identifier to restrict usage of this API key to specific users. By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.



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

def user_token
  @user_token
end

#valid_until ⇒ Object

Timestamp when the secured API key expires, measured in seconds since the Unix epoch.



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

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 164

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

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 29

def self.attribute_map
  {
    :search_params => :searchParams,
    :filters => :filters,
    :valid_until => :validUntil,
    :restrict_indices => :restrictIndices,
    :restrict_sources => :restrictSources,
    :user_token => :userToken
  }
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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 137

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



53
54
55
56
57
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 53

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

.types_mapping ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 41

def self.types_mapping
  {
    :search_params => :"SearchParamsObject",
    :filters => :"String",
    :valid_until => :"Integer",
    :restrict_indices => :"Array<String>",
    :restrict_sources => :"String",
    :user_token => :"String"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 111

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    search_params == other.search_params &&
    filters == other.filters &&
    valid_until == other.valid_until &&
    restrict_indices == other.restrict_indices &&
    restrict_sources == other.restrict_sources &&
    user_token == other.user_token
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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 243

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


124
125
126
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



130
131
132
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 130

def hash
  [search_params, filters, valid_until, restrict_indices, restrict_sources, user_token].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



214
215
216
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 214

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 224

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 



218
219
220
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 218

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



208
209
210
 
# File 'lib/algolia/models/search/secured_api_key_restrictions.rb', line 208

def to_s
  to_hash.to_s
end