Class: MailSafePro::KeyRotationRequest

Inherits:
ApiModelBase show all
Defined in:
lib/mailsafepro/models/key_rotation_request.rb

Overview

API Key rotation request

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 64

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

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

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

Instance Attribute Details

#grace_period ⇒ Object

Grace period in seconds (max 30 days)



26
27
28
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 26

def grace_period
  @grace_period
end

#new_key ⇒ Object

New API key to rotate to



23
24
25
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 23

def new_key
  @new_key
end

#old_key ⇒ Object

Current API key to rotate from



20
21
22
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 20

def old_key
  @old_key
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 29

def self.attribute_map
  {
    :'old_key' => :'old_key',
    :'new_key' => :'new_key',
    :'grace_period' => :'grace_period'
  }
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 231

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



57
58
59
60
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 48

def self.openapi_types
  {
    :'old_key' => :'String',
    :'new_key' => :'String',
    :'grace_period' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      old_key == o.old_key &&
      new_key == o.new_key &&
      grace_period == o.grace_period
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 224

def hash
  [old_key, new_key, grace_period].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



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
133
134
135
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 99

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

  if @old_key.to_s.length > 128
    invalid_properties.push('invalid value for "old_key", the character length must be smaller than or equal to 128.')
  end

  if @old_key.to_s.length < 32
    invalid_properties.push('invalid value for "old_key", the character length must be greater than or equal to 32.')
  end

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

  if @new_key.to_s.length > 128
    invalid_properties.push('invalid value for "new_key", the character length must be smaller than or equal to 128.')
  end

  if @new_key.to_s.length < 32
    invalid_properties.push('invalid value for "new_key", the character length must be greater than or equal to 32.')
  end

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

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 253

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



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/mailsafepro/models/key_rotation_request.rb', line 139

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @old_key.nil?
  return false if @old_key.to_s.length > 128
  return false if @old_key.to_s.length < 32
  return false if @new_key.nil?
  return false if @new_key.to_s.length > 128
  return false if @new_key.to_s.length < 32
  return false if !@grace_period.nil? && @grace_period > 2592000
  return false if !@grace_period.nil? && @grace_period < 0
  true
end