Class: OCI::Mysql::Models::DeletionPolicyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/mysql/models/deletion_policy_details.rb

Overview

The Deletion policy for the DB System.

Constant Summary collapse

AUTOMATIC_BACKUP_RETENTION_ENUM =
[
  AUTOMATIC_BACKUP_RETENTION_DELETE = 'DELETE'.freeze,
  AUTOMATIC_BACKUP_RETENTION_RETAIN = 'RETAIN'.freeze,
  AUTOMATIC_BACKUP_RETENTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FINAL_BACKUP_ENUM =
[
  FINAL_BACKUP_SKIP_FINAL_BACKUP = 'SKIP_FINAL_BACKUP'.freeze,
  FINAL_BACKUP_REQUIRE_FINAL_BACKUP = 'REQUIRE_FINAL_BACKUP'.freeze,
  FINAL_BACKUP_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeletionPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 72

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.automatic_backup_retention = attributes[:'automaticBackupRetention'] if attributes[:'automaticBackupRetention']
  self.automatic_backup_retention = "DELETE" if automatic_backup_retention.nil? && !attributes.key?(:'automaticBackupRetention') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :automaticBackupRetention and :automatic_backup_retention' if attributes.key?(:'automaticBackupRetention') && attributes.key?(:'automatic_backup_retention')

  self.automatic_backup_retention = attributes[:'automatic_backup_retention'] if attributes[:'automatic_backup_retention']
  self.automatic_backup_retention = "DELETE" if automatic_backup_retention.nil? && !attributes.key?(:'automaticBackupRetention') && !attributes.key?(:'automatic_backup_retention') # rubocop:disable Style/StringLiterals

  self.final_backup = attributes[:'finalBackup'] if attributes[:'finalBackup']
  self.final_backup = "SKIP_FINAL_BACKUP" if final_backup.nil? && !attributes.key?(:'finalBackup') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :finalBackup and :final_backup' if attributes.key?(:'finalBackup') && attributes.key?(:'final_backup')

  self.final_backup = attributes[:'final_backup'] if attributes[:'final_backup']
  self.final_backup = "SKIP_FINAL_BACKUP" if final_backup.nil? && !attributes.key?(:'finalBackup') && !attributes.key?(:'final_backup') # rubocop:disable Style/StringLiterals

  self.is_delete_protected = attributes[:'isDeleteProtected'] unless attributes[:'isDeleteProtected'].nil?
  self.is_delete_protected = false if is_delete_protected.nil? && !attributes.key?(:'isDeleteProtected') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isDeleteProtected and :is_delete_protected' if attributes.key?(:'isDeleteProtected') && attributes.key?(:'is_delete_protected')

  self.is_delete_protected = attributes[:'is_delete_protected'] unless attributes[:'is_delete_protected'].nil?
  self.is_delete_protected = false if is_delete_protected.nil? && !attributes.key?(:'isDeleteProtected') && !attributes.key?(:'is_delete_protected') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#automatic_backup_retentionString

[Required] Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.

Returns:

  • (String)


27
28
29
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 27

def automatic_backup_retention
  @automatic_backup_retention
end

#final_backupString

[Required] Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.

Returns:

  • (String)


34
35
36
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 34

def final_backup
  @final_backup
end

#is_delete_protectedBOOLEAN

[Required] Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.

Returns:

  • (BOOLEAN)


39
40
41
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 39

def is_delete_protected
  @is_delete_protected
end

Class Method Details

.attribute_mapObject

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



42
43
44
45
46
47
48
49
50
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'automatic_backup_retention': :'automaticBackupRetention',
    'final_backup': :'finalBackup',
    'is_delete_protected': :'isDeleteProtected'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



53
54
55
56
57
58
59
60
61
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'automatic_backup_retention': :'String',
    'final_backup': :'String',
    'is_delete_protected': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



136
137
138
139
140
141
142
143
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 136

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    automatic_backup_retention == other.automatic_backup_retention &&
    final_backup == other.final_backup &&
    is_delete_protected == other.is_delete_protected
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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 168

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


148
149
150
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 148

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



157
158
159
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 157

def hash
  [automatic_backup_retention, final_backup, is_delete_protected].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



201
202
203
204
205
206
207
208
209
210
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 201

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



195
196
197
# File 'lib/oci/mysql/models/deletion_policy_details.rb', line 195

def to_s
  to_hash.to_s
end