Class: LaunchDarklyApi::IterationInput

Inherits:
ApiModelBase show all
Defined in:
lib/launchdarkly_api/models/iteration_input.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ IterationInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LaunchDarklyApi::IterationInput` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LaunchDarklyApi::IterationInput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Object

The attributes that this iteration's results can be sliced by



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

def attributes
  @attributes
end

#can_reshuffle_traffic ⇒ Object

Whether to allow the experiment to reassign traffic to different variations when you increase or decrease the traffic in your experiment audience (true) or keep all traffic assigned to its initial variation (false). Defaults to true.



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

def can_reshuffle_traffic
  @can_reshuffle_traffic
end

#covariate_id ⇒ Object

The ID of the covariate CSV



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

def covariate_id
  @covariate_id
end

#flags ⇒ Object

Returns the value of attribute flags.



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

def flags
  @flags
end

#hypothesis ⇒ Object

The expected outcome of this experiment



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

def hypothesis
  @hypothesis
end

#metrics ⇒ Object

Returns the value of attribute metrics.



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

def metrics
  @metrics
end

#primary_funnel_key ⇒ Object

The key of the primary funnel group for this experiment. Either primarySingleMetricKey or primaryFunnelKey must be present.



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

def primary_funnel_key
  @primary_funnel_key
end

#primary_single_metric_key ⇒ Object

The key of the primary metric for this experiment. Either primarySingleMetricKey or primaryFunnelKey must be present.



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

def primary_single_metric_key
  @primary_single_metric_key
end

#randomization_unit ⇒ Object

The unit of randomization for this iteration. Defaults to user.



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

def randomization_unit
  @randomization_unit
end

#reallocation_frequency_millis ⇒ Object

The cadence (in milliseconds) to update the allocation.



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

def reallocation_frequency_millis
  @reallocation_frequency_millis
end

#treatments ⇒ Object

Returns the value of attribute treatments.



32
33
34
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 32

def treatments
  @treatments
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 49

def self.attribute_map
  {
    :'hypothesis' => :'hypothesis',
    :'can_reshuffle_traffic' => :'canReshuffleTraffic',
    :'metrics' => :'metrics',
    :'primary_single_metric_key' => :'primarySingleMetricKey',
    :'primary_funnel_key' => :'primaryFunnelKey',
    :'treatments' => :'treatments',
    :'flags' => :'flags',
    :'randomization_unit' => :'randomizationUnit',
    :'reallocation_frequency_millis' => :'reallocationFrequencyMillis',
    :'covariate_id' => :'covariateId',
    :'attributes' => :'attributes'
  }
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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 283

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 76

def self.openapi_types
  {
    :'hypothesis' => :'String',
    :'can_reshuffle_traffic' => :'Boolean',
    :'metrics' => :'Array<MetricInput>',
    :'primary_single_metric_key' => :'String',
    :'primary_funnel_key' => :'String',
    :'treatments' => :'Array<TreatmentInput>',
    :'flags' => :'Hash<String, FlagInput>',
    :'randomization_unit' => :'String',
    :'reallocation_frequency_millis' => :'Integer',
    :'covariate_id' => :'String',
    :'attributes' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 252

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      hypothesis == o.hypothesis &&
      can_reshuffle_traffic == o.can_reshuffle_traffic &&
      metrics == o.metrics &&
      primary_single_metric_key == o.primary_single_metric_key &&
      primary_funnel_key == o.primary_funnel_key &&
      treatments == o.treatments &&
      flags == o.flags &&
      randomization_unit == o.randomization_unit &&
      reallocation_frequency_millis == o.reallocation_frequency_millis &&
      covariate_id == o.covariate_id &&
      attributes == o.attributes
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


270
271
272
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [hypothesis, can_reshuffle_traffic, metrics, primary_single_metric_key, primary_funnel_key, treatments, flags, randomization_unit, reallocation_frequency_millis, covariate_id, attributes].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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 177

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @hypothesis.nil?
    invalid_properties.push('invalid value for "hypothesis", hypothesis cannot be nil.')
  end

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 305

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



201
202
203
204
205
206
207
208
 
# File 'lib/launchdarkly_api/models/iteration_input.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @hypothesis.nil?
  return false if @metrics.nil?
  return false if @treatments.nil?
  return false if @flags.nil?
  true
end