Class: MailSlurpClient::CampaignProbeRunDueResult

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/campaign_probe_run_due_result.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignProbeRunDueResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
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
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 83

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

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

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

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

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

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

Instance Attribute Details

#due_probe_countObject

Returns the value of attribute due_probe_count.



21
22
23
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 21

def due_probe_count
  @due_probe_count
end

#executed_atObject

Returns the value of attribute executed_at.



27
28
29
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 27

def executed_at
  @executed_at
end

#requested_max_runsObject

Returns the value of attribute requested_max_runs.



25
26
27
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 25

def requested_max_runs
  @requested_max_runs
end

#run_countObject

Returns the value of attribute run_count.



19
20
21
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 19

def run_count
  @run_count
end

#skipped_countObject

Returns the value of attribute skipped_count.



23
24
25
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 23

def skipped_count
  @skipped_count
end

#trigger_sourceObject

Returns the value of attribute trigger_source.



17
18
19
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 17

def trigger_source
  @trigger_source
end

Class Method Details

.attribute_mapObject

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



52
53
54
55
56
57
58
59
60
61
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 52

def self.attribute_map
  {
    :'trigger_source' => :'triggerSource',
    :'run_count' => :'runCount',
    :'due_probe_count' => :'dueProbeCount',
    :'skipped_count' => :'skippedCount',
    :'requested_max_runs' => :'requestedMaxRuns',
    :'executed_at' => :'executedAt'
  }
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



204
205
206
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 204

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

.openapi_nullableObject

List of attributes with nullable: true



76
77
78
79
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 76

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

.openapi_typesObject

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 64

def self.openapi_types
  {
    :'trigger_source' => :'String',
    :'run_count' => :'Integer',
    :'due_probe_count' => :'Integer',
    :'skipped_count' => :'Integer',
    :'requested_max_runs' => :'Integer',
    :'executed_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



178
179
180
181
182
183
184
185
186
187
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      trigger_source == o.trigger_source &&
      run_count == o.run_count &&
      due_probe_count == o.due_probe_count &&
      skipped_count == o.skipped_count &&
      requested_max_runs == o.requested_max_runs &&
      executed_at == o.executed_at
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



232
233
234
235
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
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 232

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
    MailSlurpClient.const_get(type).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



301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 301

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 211

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 191

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



197
198
199
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 197

def hash
  [trigger_source, run_count, due_probe_count, skipped_count, requested_max_runs, executed_at].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 123

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



277
278
279
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 277

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 283

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



271
272
273
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 271

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



154
155
156
157
158
159
160
161
162
163
164
# File 'lib/mailslurp_client/models/campaign_probe_run_due_result.rb', line 154

def valid?
  return false if @trigger_source.nil?
  trigger_source_validator = EnumAttributeValidator.new('String', ["DIRECT_API", "SES_MONITOR", "USER_SCHEDULE", "CRON", "SCHEDULER"])
  return false unless trigger_source_validator.valid?(@trigger_source)
  return false if @run_count.nil?
  return false if @due_probe_count.nil?
  return false if @skipped_count.nil?
  return false if @requested_max_runs.nil?
  return false if @executed_at.nil?
  true
end