Class: Shipeasy::Admin::Generated::CreateExperimentRequestGoalMetric

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb

Overview

Single goal metric defined inline — either a DSL query or an event (+aggregation/value) the server compiles. Attaching one is required before the experiment can be started. The underlying event is auto-created if missing.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 95

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

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

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

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

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

Instance Attribute Details

#aggregation ⇒ Object

Reducer for the event form. Defaults to count_users.



28
29
30
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 28

def aggregation
  @aggregation
end

#event ⇒ Object

Event name to build the metric from server-side (friendlier alternative to query). Auto-created if missing.



25
26
27
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 25

def event
  @event
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 19

def name
  @name
end

#query ⇒ Object

Metric DSL string, e.g. count_users(checkout_completed). Provide this OR event.



22
23
24
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 22

def query
  @query
end

#value ⇒ Object

Numeric event property for sum/avg aggregations (with event).



31
32
33
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 31

def value
  @value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



67
68
69
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 67

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 56

def self.attribute_map
  {
    :'name' => :'name',
    :'query' => :'query',
    :'event' => :'event',
    :'aggregation' => :'aggregation',
    :'value' => :'value'
  }
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 298

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



88
89
90
91
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 77

def self.openapi_types
  {
    :'name' => :'String',
    :'query' => :'String',
    :'event' => :'String',
    :'aggregation' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



273
274
275
276
277
278
279
280
281
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 273

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      query == o.query &&
      event == o.event &&
      aggregation == o.aggregation &&
      value == o.value
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


285
286
287
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 291

def hash
  [name, query, event, aggregation, value].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



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
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 132

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 128
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
  end

  pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
  if !@name.nil? && @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

  if !@query.nil? && @query.to_s.length > 4096
    invalid_properties.push('invalid value for "query", the character length must be smaller than or equal to 4096.')
  end

  if !@query.nil? && @query.to_s.length < 1
    invalid_properties.push('invalid value for "query", the character length must be greater than or equal to 1.')
  end

  if !@event.nil? && @event.to_s.length > 256
    invalid_properties.push('invalid value for "event", the character length must be smaller than or equal to 256.')
  end

  if !@event.nil? && @event.to_s.length < 1
    invalid_properties.push('invalid value for "event", the character length must be greater than or equal to 1.')
  end

  if !@value.nil? && @value.to_s.length > 256
    invalid_properties.push('invalid value for "value", the character length must be smaller than or equal to 256.')
  end

  if !@value.nil? && @value.to_s.length < 1
    invalid_properties.push('invalid value for "value", the character length must be greater than or equal to 1.')
  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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 320

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb', line 173

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 128
  return false if !@name.nil? && @name !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
  return false if !@query.nil? && @query.to_s.length > 4096
  return false if !@query.nil? && @query.to_s.length < 1
  return false if !@event.nil? && @event.to_s.length > 256
  return false if !@event.nil? && @event.to_s.length < 1
  aggregation_validator = EnumAttributeValidator.new('String', ["count_users", "count_events", "retention_7d", "retention_30d", "sum", "avg"])
  return false unless aggregation_validator.valid?(@aggregation)
  return false if !@value.nil? && @value.to_s.length > 256
  return false if !@value.nil? && @value.to_s.length < 1
  true
end