Class: LaunchDarklyApi::IterationRep

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IterationRep

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_id ⇒ Object

The iteration ID



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

def _id
  @_id
end

#can_reshuffle_traffic ⇒ Object

Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false).



40
41
42
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 40

def can_reshuffle_traffic
  @can_reshuffle_traffic
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#ended_at ⇒ Object

Returns the value of attribute ended_at.



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

def ended_at
  @ended_at
end

#flags ⇒ Object

Details on the flag used in this experiment



43
44
45
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 43

def flags
  @flags
end

#hypothesis ⇒ Object

The expected outcome of this experiment



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

def hypothesis
  @hypothesis
end

#metrics ⇒ Object

Details on the metrics for this experiment



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

def metrics
  @metrics
end

#primary_funnel ⇒ Object

Returns the value of attribute primary_funnel.



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

def primary_funnel
  @primary_funnel
end

#primary_metric ⇒ Object

Returns the value of attribute primary_metric.



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

def primary_metric
  @primary_metric
end

#primary_single_metric ⇒ Object

Returns the value of attribute primary_single_metric.



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

def primary_single_metric
  @primary_single_metric
end

#randomization_unit ⇒ Object

The unit of randomization for this iteration



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

def randomization_unit
  @randomization_unit
end

#secondary_metrics ⇒ Object

Deprecated, use metrics instead. Details on the secondary metrics for this experiment.



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

def secondary_metrics
  @secondary_metrics
end

#started_at ⇒ Object

Returns the value of attribute started_at.



29
30
31
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 29

def started_at
  @started_at
end

#status ⇒ Object

The status of the iteration: not_started, running, stopped



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

def status
  @status
end

#treatments ⇒ Object

Details on the variations you are testing in the experiment



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

def treatments
  @treatments
end

#winning_reason ⇒ Object

The reason you stopped the experiment



37
38
39
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 37

def winning_reason
  @winning_reason
end

#winning_treatment_id ⇒ Object

The ID of the treatment chosen when the experiment stopped



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

def winning_treatment_id
  @winning_treatment_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 64

def self.attribute_map
  {
    :'_id' => :'_id',
    :'hypothesis' => :'hypothesis',
    :'status' => :'status',
    :'created_at' => :'createdAt',
    :'started_at' => :'startedAt',
    :'ended_at' => :'endedAt',
    :'winning_treatment_id' => :'winningTreatmentId',
    :'winning_reason' => :'winningReason',
    :'can_reshuffle_traffic' => :'canReshuffleTraffic',
    :'flags' => :'flags',
    :'primary_metric' => :'primaryMetric',
    :'primary_single_metric' => :'primarySingleMetric',
    :'primary_funnel' => :'primaryFunnel',
    :'randomization_unit' => :'randomizationUnit',
    :'treatments' => :'treatments',
    :'secondary_metrics' => :'secondaryMetrics',
    :'metrics' => :'metrics'
  }
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



279
280
281
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 279

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 92

def self.openapi_types
  {
    :'_id' => :'String',
    :'hypothesis' => :'String',
    :'status' => :'String',
    :'created_at' => :'Integer',
    :'started_at' => :'Integer',
    :'ended_at' => :'Integer',
    :'winning_treatment_id' => :'String',
    :'winning_reason' => :'String',
    :'can_reshuffle_traffic' => :'Boolean',
    :'flags' => :'Hash<String, FlagRep>',
    :'primary_metric' => :'DependentMetricOrMetricGroupRep',
    :'primary_single_metric' => :'MetricV2Rep',
    :'primary_funnel' => :'DependentMetricGroupRepWithMetrics',
    :'randomization_unit' => :'String',
    :'treatments' => :'Array<TreatmentRep>',
    :'secondary_metrics' => :'Array<MetricV2Rep>',
    :'metrics' => :'Array<DependentMetricOrMetricGroupRep>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _id == o._id &&
      hypothesis == o.hypothesis &&
      status == o.status &&
      created_at == o.created_at &&
      started_at == o.started_at &&
      ended_at == o.ended_at &&
      winning_treatment_id == o.winning_treatment_id &&
      winning_reason == o.winning_reason &&
      can_reshuffle_traffic == o.can_reshuffle_traffic &&
      flags == o.flags &&
      primary_metric == o.primary_metric &&
      primary_single_metric == o.primary_single_metric &&
      primary_funnel == o.primary_funnel &&
      randomization_unit == o.randomization_unit &&
      treatments == o.treatments &&
      secondary_metrics == o.secondary_metrics &&
      metrics == o.metrics
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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 310

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 381

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 286

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


266
267
268
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 272

def hash
  [_id, hypothesis, status, created_at, started_at, ended_at, winning_treatment_id, winning_reason, can_reshuffle_traffic, flags, primary_metric, primary_single_metric, primary_funnel, randomization_unit, treatments, secondary_metrics, metrics].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



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

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

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

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



357
358
359
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 357

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 363

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



351
352
353
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 351

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



233
234
235
236
237
238
 
# File 'lib/launchdarkly_api/models/iteration_rep.rb', line 233

def valid?
  return false if @hypothesis.nil?
  return false if @status.nil?
  return false if @created_at.nil?
  true
end