Class: LaunchDarklyApi::UserSegment

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSegment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
226
227
228
229
230
231
232
233
234
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_access ⇒ Object

Returns the value of attribute _access.



50
51
52
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 50

def _access
  @_access
end

#_external ⇒ Object

The external data store backing this segment. Only applies to Big Segments.



63
64
65
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 63

def _external
  @_external
end

#_external_link ⇒ Object

The URL for the external data store backing this segment. Only applies to Big Segments.



66
67
68
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 66

def _external_link
  @_external_link
end

#_flags ⇒ Object

Returns the value of attribute _flags.



52
53
54
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 52

def _flags
  @_flags
end

#_import_in_progress ⇒ Object

Whether an import is currently in progress for the specified segment. Only applies to Big Segments.



69
70
71
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 69

def _import_in_progress
  @_import_in_progress
end

#_links ⇒ Object

The location and content type of related resources



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

def _links
  @_links
end

#_unbounded_metadata ⇒ Object

Returns the value of attribute _unbounded_metadata.



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

def _unbounded_metadata
  @_unbounded_metadata
end

#creation_date ⇒ Object

Returns the value of attribute creation_date.



27
28
29
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 27

def creation_date
  @creation_date
end

#deleted ⇒ Object

Whether the segment has been deleted



48
49
50
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 48

def deleted
  @deleted
end

#description ⇒ Object

A description of the segment’s purpose. Defaults to null and is omitted in the response if not provided.



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

def description
  @description
end

#excluded ⇒ Object

An array of user keys for excluded users. Segment rules bypass excluded users, so they will never be included based on rules. Excluded users may still be included explicitly. This value is omitted for Big Segments.



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

def excluded
  @excluded
end

#generation ⇒ Object

For Big Segments, how many times this segment has been created



58
59
60
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 58

def generation
  @generation
end

#included ⇒ Object

An array of user keys for included users. Included users are always segment members, regardless of segment rules. For Big Segments this array is either empty or omitted.



33
34
35
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 33

def included
  @included
end

#key ⇒ Object

A unique key used to reference the segment



30
31
32
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 30

def key
  @key
end

#name ⇒ Object

A human-friendly name for the segment.



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

def name
  @name
end

#rules ⇒ Object

An array of the targeting rules for this segment.



42
43
44
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 42

def rules
  @rules
end

#tags ⇒ Object

Tags for the segment. Defaults to an empty array.



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

def tags
  @tags
end

#unbounded ⇒ Object

Whether this is a standard segment (false) or a Big Segment (true). If omitted, the segment is a standard segment.



55
56
57
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 55

def unbounded
  @unbounded
end

#version ⇒ Object

Version of the segment



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

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 72

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'tags' => :'tags',
    :'creation_date' => :'creationDate',
    :'key' => :'key',
    :'included' => :'included',
    :'excluded' => :'excluded',
    :'_links' => :'_links',
    :'rules' => :'rules',
    :'version' => :'version',
    :'deleted' => :'deleted',
    :'_access' => :'_access',
    :'_flags' => :'_flags',
    :'unbounded' => :'unbounded',
    :'generation' => :'generation',
    :'_unbounded_metadata' => :'_unboundedMetadata',
    :'_external' => :'_external',
    :'_external_link' => :'_externalLink',
    :'_import_in_progress' => :'_importInProgress'
  }
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



335
336
337
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 335

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 102

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'tags' => :'Array<String>',
    :'creation_date' => :'Integer',
    :'key' => :'String',
    :'included' => :'Array<String>',
    :'excluded' => :'Array<String>',
    :'_links' => :'Hash<String, Link>',
    :'rules' => :'Array<UserSegmentRule>',
    :'version' => :'Integer',
    :'deleted' => :'Boolean',
    :'_access' => :'Access',
    :'_flags' => :'Array<FlagListingRep>',
    :'unbounded' => :'Boolean',
    :'generation' => :'Integer',
    :'_unbounded_metadata' => :'SegmentMetadata',
    :'_external' => :'String',
    :'_external_link' => :'String',
    :'_import_in_progress' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      tags == o.tags &&
      creation_date == o.creation_date &&
      key == o.key &&
      included == o.included &&
      excluded == o.excluded &&
      _links == o._links &&
      rules == o.rules &&
      version == o.version &&
      deleted == o.deleted &&
      _access == o._access &&
      _flags == o._flags &&
      unbounded == o.unbounded &&
      generation == o.generation &&
      _unbounded_metadata == o._unbounded_metadata &&
      _external == o._external &&
      _external_link == o._external_link &&
      _import_in_progress == o._import_in_progress
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



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
400
401
402
403
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 366

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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 437

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 342

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


322
323
324
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



328
329
330
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 328

def hash
  [name, description, tags, creation_date, key, included, excluded, _links, rules, version, deleted, _access, _flags, unbounded, generation, _unbounded_metadata, _external, _external_link, _import_in_progress].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



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
273
274
275
276
277
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 238

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

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

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

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

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

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

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

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

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



413
414
415
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 419

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



407
408
409
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 407

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



281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 281

def valid?
  return false if @name.nil?
  return false if @tags.nil?
  return false if @creation_date.nil?
  return false if @key.nil?
  return false if @_links.nil?
  return false if @rules.nil?
  return false if @version.nil?
  return false if @deleted.nil?
  return false if @generation.nil?
  true
end