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



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 88

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_flags ⇒ Object

Returns the value of attribute _flags.



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

def _flags
  @_flags
end

#_links ⇒ Object

Returns the value of attribute _links.



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

def _links
  @_links
end

#creation_date ⇒ Object

A unix epoch time in milliseconds specifying the creation time of this flag.



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

def creation_date
  @creation_date
end

#description ⇒ Object

Description of the user segment.



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

def description
  @description
end

#excluded ⇒ Object

An array of user keys that should not be included in this segment, unless they are also listed in "included".



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

def excluded
  @excluded
end

#included ⇒ Object

An array of user keys that are included in this segment.



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

def included
  @included
end

#key ⇒ Object

Unique identifier for the user segment.



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

def key
  @key
end

#name ⇒ Object

Name of the user segment.



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

def name
  @name
end

#rules ⇒ Object

An array of rules that can cause a user to be included in this segment.



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

def rules
  @rules
end

#tags ⇒ Object

An array of tags for this user segment.



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

def tags
  @tags
end

#unbounded ⇒ Object

Controls whether this segment can support unlimited numbers of users. Requires the beta API and additional setup. Include/exclude lists in this payload are not used in unbounded segments.



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

def unbounded
  @unbounded
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 51

def self.attribute_map
  {
    :'key' => :'key',
    :'name' => :'name',
    :'description' => :'description',
    :'tags' => :'tags',
    :'creation_date' => :'creationDate',
    :'included' => :'included',
    :'excluded' => :'excluded',
    :'rules' => :'rules',
    :'unbounded' => :'unbounded',
    :'version' => :'version',
    :'_links' => :'_links',
    :'_flags' => :'_flags'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 69

def self.swagger_types
  {
    :'key' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'tags' => :'Array<String>',
    :'creation_date' => :'Integer',
    :'included' => :'Array<String>',
    :'excluded' => :'Array<String>',
    :'rules' => :'Array<UserSegmentRule>',
    :'unbounded' => :'BOOLEAN',
    :'version' => :'Integer',
    :'_links' => :'Links',
    :'_flags' => :'Array<FlagListItem>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      name == o.name &&
      description == o.description &&
      tags == o.tags &&
      creation_date == o.creation_date &&
      included == o.included &&
      excluded == o.excluded &&
      rules == o.rules &&
      unbounded == o.unbounded &&
      version == o.version &&
      _links == o._links &&
      _flags == o._flags
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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/user_segment.rb', line 236

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = LaunchDarklyApi.const_get(type).new
    temp_model.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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 302

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 215

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


202
203
204
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



208
209
210
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 208

def hash
  [key, name, description, tags, creation_date, included, excluded, rules, unbounded, version, _links, _flags].hash
end

#list_invalid_properties ⇒ Object

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 155

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



282
283
284
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 282

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 288

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



276
277
278
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 276

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



174
175
176
177
178
179
 
# File 'lib/launchdarkly_api/models/user_segment.rb', line 174

def valid?
  return false if @key.nil?
  return false if @name.nil?
  return false if @creation_date.nil?
  true
end