Class: MailSlurpClient::UpdateDeliverabilityTestOptions

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

Overview

Update a deliverability/load test

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDeliverabilityTestOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 86

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

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

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

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

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

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

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

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

Instance Attribute Details

#clear_max_duration ⇒ Object

Set true to clear timeout. If true, maxDurationSeconds is ignored for this request.



31
32
33
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 31

def clear_max_duration
  @clear_max_duration
end

#clear_success_threshold ⇒ Object

Set true to clear success threshold. If true, successThresholdPercent is ignored for this request.



37
38
39
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 37

def clear_success_threshold
  @clear_success_threshold
end

#description ⇒ Object

Optional updated description



22
23
24
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 22

def description
  @description
end

#expectations ⇒ Object

Optional replacement expectations



40
41
42
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 40

def expectations
  @expectations
end

#max_duration_seconds ⇒ Object

Optional updated timeout in seconds



28
29
30
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 28

def max_duration_seconds
  @max_duration_seconds
end

#name ⇒ Object

Optional updated name



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

def name
  @name
end

#start_at ⇒ Object

Optional updated receive-window start time. Only applied while test is not terminal.



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

def start_at
  @start_at
end

#success_threshold_percent ⇒ Object

Optional updated acceptable success threshold percentage (0,100].



34
35
36
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 34

def success_threshold_percent
  @success_threshold_percent
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 43

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'start_at' => :'startAt',
    :'max_duration_seconds' => :'maxDurationSeconds',
    :'clear_max_duration' => :'clearMaxDuration',
    :'success_threshold_percent' => :'successThresholdPercent',
    :'clear_success_threshold' => :'clearSuccessThreshold',
    :'expectations' => :'expectations'
  }
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



216
217
218
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 71

def self.openapi_nullable
  Set.new([
    :'name',
    :'description',
    :'start_at',
    :'max_duration_seconds',
    :'clear_max_duration',
    :'success_threshold_percent',
    :'clear_success_threshold',
    :'expectations'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 57

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'start_at' => :'DateTime',
    :'max_duration_seconds' => :'Integer',
    :'clear_max_duration' => :'Boolean',
    :'success_threshold_percent' => :'Float',
    :'clear_success_threshold' => :'Boolean',
    :'expectations' => :'Array<DeliverabilityExpectation>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      start_at == o.start_at &&
      max_duration_seconds == o.max_duration_seconds &&
      clear_max_duration == o.clear_max_duration &&
      success_threshold_percent == o.success_threshold_percent &&
      clear_success_threshold == o.clear_success_threshold &&
      expectations == o.expectations
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



244
245
246
247
248
249
250
251
252
253
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
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 244

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 313

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 223

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


203
204
205
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 209

def hash
  [name, description, start_at, max_duration_seconds, clear_max_duration, success_threshold_percent, clear_success_threshold, expectations].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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  if !@max_duration_seconds.nil? && @max_duration_seconds < 1
    invalid_properties.push('invalid value for "max_duration_seconds", must be greater than or equal to 1.')
  end

  if !@success_threshold_percent.nil? && @success_threshold_percent > 100.0
    invalid_properties.push('invalid value for "success_threshold_percent", must be smaller than or equal to 100.0.')
  end

  if !@success_threshold_percent.nil? && @success_threshold_percent <= 0.0
    invalid_properties.push('invalid value for "success_threshold_percent", must be greater than 0.0.')
  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



289
290
291
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 295

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



283
284
285
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 283

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



155
156
157
158
159
160
 
# File 'lib/mailslurp_client/models/update_deliverability_test_options.rb', line 155

def valid?
  return false if !@max_duration_seconds.nil? && @max_duration_seconds < 1
  return false if !@success_threshold_percent.nil? && @success_threshold_percent > 100.0
  return false if !@success_threshold_percent.nil? && @success_threshold_percent <= 0.0
  true
end