Class: LaunchDarklyApi::FeatureFlagConfig

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FeatureFlagConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
184
185
186
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
225
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 129

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_access ⇒ Object

Returns the value of attribute _access.



51
52
53
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 51

def _access
  @_access
end

#_debug_events_until_date ⇒ Object

Returns the value of attribute _debug_events_until_date.



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

def _debug_events_until_date
  @_debug_events_until_date
end

#_environment_name ⇒ Object

The environment name



54
55
56
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 54

def _environment_name
  @_environment_name
end

#_site ⇒ Object

Returns the value of attribute _site.



49
50
51
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 49

def _site
  @_site
end

#_summary ⇒ Object

Returns the value of attribute _summary.



64
65
66
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 64

def _summary
  @_summary
end

#archived ⇒ Object

Boolean indicating if the feature flag is archived



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

def archived
  @archived
end

#context_targets ⇒ Object

Returns the value of attribute context_targets.



36
37
38
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 36

def context_targets
  @context_targets
end

#fallthrough ⇒ Object

Returns the value of attribute fallthrough.



41
42
43
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 41

def fallthrough
  @fallthrough
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



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

def last_modified
  @last_modified
end

#off_variation ⇒ Object

The ID of the variation to serve when the flag is off



44
45
46
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 44

def off_variation
  @off_variation
end

#on ⇒ Object

Whether the flag is on



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

def on
  @on
end

#prerequisites ⇒ Object

An array of the prerequisite flags and their variations that are required before this flag takes effect



47
48
49
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 47

def prerequisites
  @prerequisites
end

#rules ⇒ Object

An array of the rules for how to serve a variation to specific targets based on their attributes



39
40
41
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 39

def rules
  @rules
end

#salt ⇒ Object

Returns the value of attribute salt.



24
25
26
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 24

def salt
  @salt
end

#sel ⇒ Object

Returns the value of attribute sel.



26
27
28
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 26

def sel
  @sel
end

#targets ⇒ Object

An array of the individual targets that will receive a specific variation based on their key



34
35
36
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 34

def targets
  @targets
end

#track_events ⇒ Object

Whether LaunchDarkly tracks events for the feature flag, for all rules



57
58
59
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 57

def track_events
  @track_events
end

#track_events_fallthrough ⇒ Object

Whether LaunchDarkly tracks events for the feature flag, for the default rule



60
61
62
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 60

def track_events_fallthrough
  @track_events_fallthrough
end

#version ⇒ Object

Version of the feature flag



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

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 67

def self.attribute_map
  {
    :'on' => :'on',
    :'archived' => :'archived',
    :'salt' => :'salt',
    :'sel' => :'sel',
    :'last_modified' => :'lastModified',
    :'version' => :'version',
    :'targets' => :'targets',
    :'context_targets' => :'contextTargets',
    :'rules' => :'rules',
    :'fallthrough' => :'fallthrough',
    :'off_variation' => :'offVariation',
    :'prerequisites' => :'prerequisites',
    :'_site' => :'_site',
    :'_access' => :'_access',
    :'_environment_name' => :'_environmentName',
    :'track_events' => :'trackEvents',
    :'track_events_fallthrough' => :'trackEventsFallthrough',
    :'_debug_events_until_date' => :'_debugEventsUntilDate',
    :'_summary' => :'_summary'
  }
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



331
332
333
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 331

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 97

def self.openapi_types
  {
    :'on' => :'Boolean',
    :'archived' => :'Boolean',
    :'salt' => :'String',
    :'sel' => :'String',
    :'last_modified' => :'Integer',
    :'version' => :'Integer',
    :'targets' => :'Array<Target>',
    :'context_targets' => :'Array<Target>',
    :'rules' => :'Array<Rule>',
    :'fallthrough' => :'VariationOrRolloutRep',
    :'off_variation' => :'Integer',
    :'prerequisites' => :'Array<Prerequisite>',
    :'_site' => :'Link',
    :'_access' => :'Access',
    :'_environment_name' => :'String',
    :'track_events' => :'Boolean',
    :'track_events_fallthrough' => :'Boolean',
    :'_debug_events_until_date' => :'Integer',
    :'_summary' => :'FlagSummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 292

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      on == o.on &&
      archived == o.archived &&
      salt == o.salt &&
      sel == o.sel &&
      last_modified == o.last_modified &&
      version == o.version &&
      targets == o.targets &&
      context_targets == o.context_targets &&
      rules == o.rules &&
      fallthrough == o.fallthrough &&
      off_variation == o.off_variation &&
      prerequisites == o.prerequisites &&
      _site == o._site &&
      _access == o._access &&
      _environment_name == o._environment_name &&
      track_events == o.track_events &&
      track_events_fallthrough == o.track_events_fallthrough &&
      _debug_events_until_date == o._debug_events_until_date &&
      _summary == o._summary
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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 362

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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 433

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 338

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


318
319
320
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



324
325
326
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 324

def hash
  [on, archived, salt, sel, last_modified, version, targets, context_targets, rules, fallthrough, off_variation, prerequisites, _site, _access, _environment_name, track_events, track_events_fallthrough, _debug_events_until_date, _summary].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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 229

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

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

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

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

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

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

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

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

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

  if @track_events_fallthrough.nil?
    invalid_properties.push('invalid value for "track_events_fallthrough", track_events_fallthrough 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



409
410
411
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 409

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 415

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



403
404
405
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 403

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/launchdarkly_api/models/feature_flag_config.rb', line 276

def valid?
  return false if @on.nil?
  return false if @archived.nil?
  return false if @salt.nil?
  return false if @sel.nil?
  return false if @last_modified.nil?
  return false if @version.nil?
  return false if @_site.nil?
  return false if @_environment_name.nil?
  return false if @track_events.nil?
  return false if @track_events_fallthrough.nil?
  true
end