Class: LaunchDarklyApi::Contexts

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/models/contexts.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Contexts

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 68

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LaunchDarklyApi::Contexts` 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))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LaunchDarklyApi::Contexts`. 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?(:'_links')
    if (value = attributes[:'_links']).is_a?(Hash)
      self._links = value
    end
  end

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

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

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

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

Instance Attribute Details

#_environment_id ⇒ Object

The environment ID where the context was evaluated



25
26
27
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 25

def _environment_id
  @_environment_id
end

#_links ⇒ Object

The location and content type of related resources



19
20
21
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 19

def _links
  @_links
end

#continuation_token ⇒ Object

An obfuscated string that references the last context instance on the previous page of results. You can use this for pagination, however, we recommend using the next link instead.



28
29
30
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 28

def continuation_token
  @continuation_token
end

#items ⇒ Object

A collection of contexts. Can include multiple versions of contexts that have the same kind and key, but different applicationIds.



31
32
33
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 31

def items
  @items
end

#total_count ⇒ Object

The number of contexts



22
23
24
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 22

def total_count
  @total_count
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 34

def self.attribute_map
  {
    :'_links' => :'_links',
    :'total_count' => :'totalCount',
    :'_environment_id' => :'_environmentId',
    :'continuation_token' => :'continuationToken',
    :'items' => :'items'
  }
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



156
157
158
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 156

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 50

def self.openapi_types
  {
    :'_links' => :'Hash<String, Link>',
    :'total_count' => :'Integer',
    :'_environment_id' => :'String',
    :'continuation_token' => :'String',
    :'items' => :'Array<ContextRecord>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
137
138
139
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      total_count == o.total_count &&
      _environment_id == o._environment_id &&
      continuation_token == o.continuation_token &&
      items == o.items
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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 187

def _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
  else # model
    # models (e.g. Pet) or oneOf
    klass = LaunchDarklyApi.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 258

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 163

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", 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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



149
150
151
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 149

def hash
  [_links, total_count, _environment_id, continuation_token, items].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  if @_environment_id.nil?
    invalid_properties.push('invalid value for "_environment_id", _environment_id cannot be nil.')
  end

  if @items.nil?
    invalid_properties.push('invalid value for "items", items cannot be nil.')
  end

  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



234
235
236
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 234

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 240

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



228
229
230
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 228

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



123
124
125
126
127
 
# File 'lib/launchdarkly_api/models/contexts.rb', line 123

def valid?
  return false if @_environment_id.nil?
  return false if @items.nil?
  true
end