Class: OCI::Mysql::Models::CreateBackupPolicyDetails

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

Overview

Backup policy as optionally used for DB System Creation.

Constant Summary collapse

SOFT_DELETE_ENUM = 
[
  SOFT_DELETE_ENABLED = 'ENABLED'.freeze,
  SOFT_DELETE_DISABLED = 'DISABLED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBackupPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



118
119
120
121
122
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 118

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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

  self.soft_delete = attributes[:'softDelete'] if attributes[:'softDelete']

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

  self.soft_delete = attributes[:'soft_delete'] if attributes[:'soft_delete']

  self.copy_policies = attributes[:'copyPolicies'] if attributes[:'copyPolicies']

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

  self.copy_policies = attributes[:'copy_policies'] if attributes[:'copy_policies']

  self.window_start_time = attributes[:'windowStartTime'] if attributes[:'windowStartTime']

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

  self.window_start_time = attributes[:'window_start_time'] if attributes[:'window_start_time']

  self.retention_in_days = attributes[:'retentionInDays'] if attributes[:'retentionInDays']

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

  self.retention_in_days = attributes[:'retention_in_days'] if attributes[:'retention_in_days']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.pitr_policy = attributes[:'pitrPolicy'] if attributes[:'pitrPolicy']

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

  self.pitr_policy = attributes[:'pitr_policy'] if attributes[:'pitr_policy']
end

Instance Attribute Details

#copy_policies ⇒ Array<OCI::Mysql::Models::CopyPolicy>

List of policies of a DB system to schedule cross-region DB system backup copy.

The policy includes the name of the destination region to which the DB system backup will be copied, and an optional parameter which specifies the retention period of the copied DB system backup in days.

Note: Currently, only one policy can be specified in the list.

Returns:



36
37
38
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 36

def copy_policies
  @copy_policies
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces.

Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.

Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


67
68
69
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 67

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.

Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.

Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


58
59
60
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 58

def freeform_tags
  @freeform_tags
end

#is_enabled ⇒ BOOLEAN

Specifies if automatic backups are enabled.

Returns:

  • (BOOLEAN) 


20
21
22
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 20

def is_enabled
  @is_enabled
end

#pitr_policy ⇒ OCI::Mysql::Models::PitrPolicy

Returns:



70
71
72
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 70

def pitr_policy
  @pitr_policy
end

#retention_in_days ⇒ Integer

Number of days to retain an automatic backup.

Returns:

  • (Integer) 


49
50
51
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 49

def retention_in_days
  @retention_in_days
end

#soft_delete ⇒ String

Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 26

def soft_delete
  @soft_delete
end

#window_start_time ⇒ String

The start of a 30-minute window of time in which daily, automated backups occur.

This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.

At some point in the window, the system may incur a brief service disruption as the backup is performed.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 45

def window_start_time
  @window_start_time
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 73

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'soft_delete': :'softDelete',
    'copy_policies': :'copyPolicies',
    'window_start_time': :'windowStartTime',
    'retention_in_days': :'retentionInDays',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'pitr_policy': :'pitrPolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'soft_delete': :'String',
    'copy_policies': :'Array<OCI::Mysql::Models::CopyPolicy>',
    'window_start_time': :'String',
    'retention_in_days': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'pitr_policy': :'OCI::Mysql::Models::PitrPolicy'
    # 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



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 190

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

  self.class == other.class &&
    is_enabled == other.is_enabled &&
    soft_delete == other.soft_delete &&
    copy_policies == other.copy_policies &&
    window_start_time == other.window_start_time &&
    retention_in_days == other.retention_in_days &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    pitr_policy == other.pitr_policy
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 227

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


207
208
209
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 216

def hash
  [is_enabled, soft_delete, copy_policies, window_start_time, retention_in_days, freeform_tags, defined_tags, pitr_policy].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 260

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



254
255
256
 
# File 'lib/oci/mysql/models/create_backup_policy_details.rb', line 254

def to_s
  to_hash.to_s
end