Class: LaunchDarklyApi::MetricRep

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

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ MetricRep

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 320

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_access ⇒ Object

Returns the value of attribute _access.



56
57
58
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 56

def _access
  @_access
end

#_attached_features ⇒ Object

Details on the flags attached to this metric



160
161
162
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 160

def _attached_features
  @_attached_features
end

#_attached_flag_count ⇒ Object

The number of feature flags currently attached to this metric



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

def _attached_flag_count
  @_attached_flag_count
end

#_creation_date ⇒ Object

Returns the value of attribute _creation_date.



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

def _creation_date
  @_creation_date
end

#_id ⇒ Object

The ID of this metric



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

def _id
  @_id
end

#_links ⇒ Object

The location and content type of related resources



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

def _links
  @_links
end

#_maintainer ⇒ Object

Returns the value of attribute _maintainer.



68
69
70
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 68

def _maintainer
  @_maintainer
end

#_site ⇒ Object

Returns the value of attribute _site.



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

def _site
  @_site
end

#_version ⇒ Object

Version of the metric



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

def _version
  @_version
end

#_version_id ⇒ Object

The version ID of the metric



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

def _version_id
  @_version_id
end

#active_experiment_count ⇒ Object

The number of active experiments using this metric



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

def active_experiment_count
  @active_experiment_count
end

#active_guarded_rollout_count ⇒ Object

The number of active guarded rollouts using this metric



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

def active_guarded_rollout_count
  @active_guarded_rollout_count
end

#analysis_type ⇒ Object

The method for analyzing metric events



100
101
102
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 100

def analysis_type
  @analysis_type
end

#analysis_units ⇒ Object

An array of analysis units allowed for this metric.



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

def analysis_units
  @analysis_units
end

#archived ⇒ Object

Whether the metric version is archived



112
113
114
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 112

def archived
  @archived
end

#archived_at ⇒ Object

Returns the value of attribute archived_at.



114
115
116
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 114

def archived_at
  @archived_at
end

#category ⇒ Object

The category of the metric



74
75
76
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 74

def category
  @category
end

#data_source ⇒ Object

Returns the value of attribute data_source.



107
108
109
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 107

def data_source
  @data_source
end

#denominator ⇒ Object

Returns the value of attribute denominator.



145
146
147
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 145

def denominator
  @denominator
end

#description ⇒ Object

Description of the metric



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

def description
  @description
end

#event_default ⇒ Object

Returns the value of attribute event_default.



105
106
107
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 105

def event_default
  @event_default
end

#event_key ⇒ Object

For custom metrics, the event key to use in your code



86
87
88
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 86

def event_key
  @event_key
end

#experiment_count ⇒ Object

The number of experiments using this metric



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

def experiment_count
  @experiment_count
end

#experiments ⇒ Object

Returns the value of attribute experiments.



147
148
149
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 147

def experiments
  @experiments
end

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#is_active ⇒ Object

Whether the metric is active



157
158
159
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 157

def is_active
  @is_active
end

#is_numeric ⇒ Object

For custom and trace metrics, whether to track numeric changes in value against a baseline (true) or to track a conversion when an end user takes an action (false).



77
78
79
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 77

def is_numeric
  @is_numeric
end

#key ⇒ Object

A unique key to reference the metric



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

def key
  @key
end

#kind ⇒ Object

The kind of event the metric tracks



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

def kind
  @kind
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



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

def last_modified
  @last_modified
end

#last_seen ⇒ Object

Returns the value of attribute last_seen.



109
110
111
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 109

def last_seen
  @last_seen
end

#last_used_in_experiment ⇒ Object

Returns the value of attribute last_used_in_experiment.



152
153
154
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 152

def last_used_in_experiment
  @last_used_in_experiment
end

#last_used_in_guarded_rollout ⇒ Object

Returns the value of attribute last_used_in_guarded_rollout.



154
155
156
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 154

def last_used_in_guarded_rollout
  @last_used_in_guarded_rollout
end

#maintainer_id ⇒ Object

The ID of the member who maintains this metric



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

def maintainer_id
  @maintainer_id
end

#metric_group_count ⇒ Object

The number of metric groups using this metric



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

def metric_group_count
  @metric_group_count
end

#metric_groups ⇒ Object

Metric groups that use this metric



150
151
152
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 150

def metric_groups
  @metric_groups
end

#name ⇒ Object

A human-friendly name for the metric



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

def name
  @name
end

#percentile_value ⇒ Object

The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when analysisType is percentile.



103
104
105
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 103

def percentile_value
  @percentile_value
end

#randomization_units ⇒ Object

Deprecated, use analysisUnits instead.



89
90
91
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 89

def randomization_units
  @randomization_units
end

#selector ⇒ Object

For click metrics, the CSS selectors



117
118
119
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 117

def selector
  @selector
end

#success_criteria ⇒ Object

For custom and trace metrics, the success criteria



80
81
82
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 80

def success_criteria
  @success_criteria
end

#tags ⇒ Object

Tags for the metric



59
60
61
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 59

def tags
  @tags
end

#trace_query ⇒ Object

For trace metrics, the trace query to use for the metric.



140
141
142
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 140

def trace_query
  @trace_query
end

#trace_value_location ⇒ Object

For trace metrics, the location in the trace to use for numeric values.



143
144
145
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 143

def trace_value_location
  @trace_value_location
end

#unit ⇒ Object

For numeric custom and trace metrics, the unit of measure



83
84
85
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 83

def unit
  @unit
end

#unit_aggregation_type ⇒ Object

The method by which multiple unit event values are aggregated



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

def unit_aggregation_type
  @unit_aggregation_type
end

#urls ⇒ Object

Returns the value of attribute urls.



119
120
121
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 119

def urls
  @urls
end

#window_end_offset ⇒ Object

Not yet implemented - The end of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation



125
126
127
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 125

def window_end_offset
  @window_end_offset
end

#window_start_offset ⇒ Object

Not yet implemented - The start of the measurement window, in milliseconds relative to the unit's first exposure to a flag variation



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

def window_start_offset
  @window_start_offset
end

#winsor_exclude_imputed ⇒ Object

Deprecated and ignored. Use winsorIncludeImputed instead.



134
135
136
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 134

def winsor_exclude_imputed
  @winsor_exclude_imputed
end

#winsor_include_imputed ⇒ Object

When true, the percentile bound calculation includes imputed zeros. Only meaningful when at least one bound is set and the metric includes units that didn't send events.



137
138
139
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 137

def winsor_include_imputed
  @winsor_include_imputed
end

#winsor_lower_percentile ⇒ Object

Lower winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, defines a two-sided clamp range. Otherwise lower-only winsorization.



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

def winsor_lower_percentile
  @winsor_lower_percentile
end

#winsor_upper_percentile ⇒ Object

Upper winsorization percentile, expressed as a percent in the open interval (0, 100). When both bounds are set, must be greater than winsorLowerPercentile.



131
132
133
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 131

def winsor_upper_percentile
  @winsor_upper_percentile
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



244
245
246
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 244

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



249
250
251
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 249

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
235
236
237
238
239
240
241
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 185

def self.attribute_map
  {
    :'experiment_count' => :'experimentCount',
    :'metric_group_count' => :'metricGroupCount',
    :'active_experiment_count' => :'activeExperimentCount',
    :'active_guarded_rollout_count' => :'activeGuardedRolloutCount',
    :'_id' => :'_id',
    :'_version_id' => :'_versionId',
    :'_version' => :'_version',
    :'key' => :'key',
    :'name' => :'name',
    :'kind' => :'kind',
    :'_attached_flag_count' => :'_attachedFlagCount',
    :'_links' => :'_links',
    :'_site' => :'_site',
    :'_access' => :'_access',
    :'tags' => :'tags',
    :'_creation_date' => :'_creationDate',
    :'last_modified' => :'lastModified',
    :'maintainer_id' => :'maintainerId',
    :'_maintainer' => :'_maintainer',
    :'description' => :'description',
    :'category' => :'category',
    :'is_numeric' => :'isNumeric',
    :'success_criteria' => :'successCriteria',
    :'unit' => :'unit',
    :'event_key' => :'eventKey',
    :'randomization_units' => :'randomizationUnits',
    :'analysis_units' => :'analysisUnits',
    :'filters' => :'filters',
    :'unit_aggregation_type' => :'unitAggregationType',
    :'analysis_type' => :'analysisType',
    :'percentile_value' => :'percentileValue',
    :'event_default' => :'eventDefault',
    :'data_source' => :'dataSource',
    :'last_seen' => :'lastSeen',
    :'archived' => :'archived',
    :'archived_at' => :'archivedAt',
    :'selector' => :'selector',
    :'urls' => :'urls',
    :'window_start_offset' => :'windowStartOffset',
    :'window_end_offset' => :'windowEndOffset',
    :'winsor_lower_percentile' => :'winsorLowerPercentile',
    :'winsor_upper_percentile' => :'winsorUpperPercentile',
    :'winsor_exclude_imputed' => :'winsorExcludeImputed',
    :'winsor_include_imputed' => :'winsorIncludeImputed',
    :'trace_query' => :'traceQuery',
    :'trace_value_location' => :'traceValueLocation',
    :'denominator' => :'denominator',
    :'experiments' => :'experiments',
    :'metric_groups' => :'metricGroups',
    :'last_used_in_experiment' => :'lastUsedInExperiment',
    :'last_used_in_guarded_rollout' => :'lastUsedInGuardedRollout',
    :'is_active' => :'isActive',
    :'_attached_features' => :'_attachedFeatures'
  }
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



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 844

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



313
314
315
316
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 313

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

.openapi_types ⇒ Object

Attribute type mapping.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 254

def self.openapi_types
  {
    :'experiment_count' => :'Integer',
    :'metric_group_count' => :'Integer',
    :'active_experiment_count' => :'Integer',
    :'active_guarded_rollout_count' => :'Integer',
    :'_id' => :'String',
    :'_version_id' => :'String',
    :'_version' => :'Integer',
    :'key' => :'String',
    :'name' => :'String',
    :'kind' => :'String',
    :'_attached_flag_count' => :'Integer',
    :'_links' => :'Hash<String, Link>',
    :'_site' => :'Link',
    :'_access' => :'Access',
    :'tags' => :'Array<String>',
    :'_creation_date' => :'Integer',
    :'last_modified' => :'Modification',
    :'maintainer_id' => :'String',
    :'_maintainer' => :'MemberSummary',
    :'description' => :'String',
    :'category' => :'String',
    :'is_numeric' => :'Boolean',
    :'success_criteria' => :'String',
    :'unit' => :'String',
    :'event_key' => :'String',
    :'randomization_units' => :'Array<String>',
    :'analysis_units' => :'Array<String>',
    :'filters' => :'Filter',
    :'unit_aggregation_type' => :'String',
    :'analysis_type' => :'String',
    :'percentile_value' => :'Integer',
    :'event_default' => :'MetricEventDefaultRep',
    :'data_source' => :'MetricDataSourceRefRep',
    :'last_seen' => :'Integer',
    :'archived' => :'Boolean',
    :'archived_at' => :'Integer',
    :'selector' => :'String',
    :'urls' => :'Array<Hash>',
    :'window_start_offset' => :'Integer',
    :'window_end_offset' => :'Integer',
    :'winsor_lower_percentile' => :'Float',
    :'winsor_upper_percentile' => :'Float',
    :'winsor_exclude_imputed' => :'Boolean',
    :'winsor_include_imputed' => :'Boolean',
    :'trace_query' => :'String',
    :'trace_value_location' => :'String',
    :'denominator' => :'MetricDenominatorRep',
    :'experiments' => :'Array<DependentExperimentRep>',
    :'metric_groups' => :'Array<DependentMetricGroupRep>',
    :'last_used_in_experiment' => :'DependentExperimentRep',
    :'last_used_in_guarded_rollout' => :'DependentMeasuredRolloutRep',
    :'is_active' => :'Boolean',
    :'_attached_features' => :'Array<FlagListingRep>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 771

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      experiment_count == o.experiment_count &&
      metric_group_count == o.metric_group_count &&
      active_experiment_count == o.active_experiment_count &&
      active_guarded_rollout_count == o.active_guarded_rollout_count &&
      _id == o._id &&
      _version_id == o._version_id &&
      _version == o._version &&
      key == o.key &&
      name == o.name &&
      kind == o.kind &&
      _attached_flag_count == o._attached_flag_count &&
      _links == o._links &&
      _site == o._site &&
      _access == o._access &&
      tags == o.tags &&
      _creation_date == o._creation_date &&
      last_modified == o.last_modified &&
      maintainer_id == o.maintainer_id &&
      _maintainer == o._maintainer &&
      description == o.description &&
      category == o.category &&
      is_numeric == o.is_numeric &&
      success_criteria == o.success_criteria &&
      unit == o.unit &&
      event_key == o.event_key &&
      randomization_units == o.randomization_units &&
      analysis_units == o.analysis_units &&
      filters == o.filters &&
      unit_aggregation_type == o.unit_aggregation_type &&
      analysis_type == o.analysis_type &&
      percentile_value == o.percentile_value &&
      event_default == o.event_default &&
      data_source == o.data_source &&
      last_seen == o.last_seen &&
      archived == o.archived &&
      archived_at == o.archived_at &&
      selector == o.selector &&
      urls == o.urls &&
      window_start_offset == o.window_start_offset &&
      window_end_offset == o.window_end_offset &&
      winsor_lower_percentile == o.winsor_lower_percentile &&
      winsor_upper_percentile == o.winsor_upper_percentile &&
      winsor_exclude_imputed == o.winsor_exclude_imputed &&
      winsor_include_imputed == o.winsor_include_imputed &&
      trace_query == o.trace_query &&
      trace_value_location == o.trace_value_location &&
      denominator == o.denominator &&
      experiments == o.experiments &&
      metric_groups == o.metric_groups &&
      last_used_in_experiment == o.last_used_in_experiment &&
      last_used_in_guarded_rollout == o.last_used_in_guarded_rollout &&
      is_active == o.is_active &&
      _attached_features == o._attached_features
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


831
832
833
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 831

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



837
838
839
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 837

def hash
  [experiment_count, metric_group_count, active_experiment_count, active_guarded_rollout_count, _id, _version_id, _version, key, name, kind, _attached_flag_count, _links, _site, _access, tags, _creation_date, last_modified, maintainer_id, _maintainer, description, category, is_numeric, success_criteria, unit, event_key, randomization_units, analysis_units, filters, unit_aggregation_type, analysis_type, percentile_value, event_default, data_source, last_seen, archived, archived_at, selector, urls, window_start_offset, window_end_offset, winsor_lower_percentile, winsor_upper_percentile, winsor_exclude_imputed, winsor_include_imputed, trace_query, trace_value_location, denominator, experiments, metric_groups, last_used_in_experiment, last_used_in_guarded_rollout, is_active, _attached_features].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



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 583

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

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

  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 @kind.nil?
    invalid_properties.push('invalid value for "kind", kind cannot be nil.')
  end

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



866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 866

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



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/launchdarkly_api/models/metric_rep.rb', line 627

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @_id.nil?
  return false if @_version_id.nil?
  return false if @key.nil?
  return false if @name.nil?
  return false if @kind.nil?
  kind_validator = EnumAttributeValidator.new('String', ["pageview", "click", "custom", "trace"])
  return false unless kind_validator.valid?(@kind)
  return false if @_links.nil?
  return false if @tags.nil?
  return false if @_creation_date.nil?
  success_criteria_validator = EnumAttributeValidator.new('String', ["HigherThanBaseline", "LowerThanBaseline"])
  return false unless success_criteria_validator.valid?(@success_criteria)
  unit_aggregation_type_validator = EnumAttributeValidator.new('String', ["average", "sum", "count_distinct"])
  return false unless unit_aggregation_type_validator.valid?(@unit_aggregation_type)
  analysis_type_validator = EnumAttributeValidator.new('String', ["mean", "percentile"])
  return false unless analysis_type_validator.valid?(@analysis_type)
  return false if @data_source.nil?
  true
end