Class: OCI::Recovery::Models::ProtectionPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/recovery/models/protection_policy.rb

Overview

The details of a protection policy.A policy defines the exact number of days to retain protected database backups created by Recovery Service. Each protected database must be associated with one protection policy. You can use Oracle-defined protection policies or create custom policies to suit your internal backup storage regulation demands.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETE_SCHEDULED = 'DELETE_SCHEDULED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProtectionPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :backup_retention_period_in_days (Integer) —

    The value to assign to the #backup_retention_period_in_days property

  • :is_predefined_policy (BOOLEAN) —

    The value to assign to the #is_predefined_policy property

  • :policy_locked_date_time (String) —

    The value to assign to the #policy_locked_date_time property

  • :must_enforce_cloud_locality (BOOLEAN) —

    The value to assign to the #must_enforce_cloud_locality property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 155

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.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.backup_retention_period_in_days = attributes[:'backupRetentionPeriodInDays'] if attributes[:'backupRetentionPeriodInDays']

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

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

  self.is_predefined_policy = attributes[:'isPredefinedPolicy'] unless attributes[:'isPredefinedPolicy'].nil?

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

  self.is_predefined_policy = attributes[:'is_predefined_policy'] unless attributes[:'is_predefined_policy'].nil?

  self.policy_locked_date_time = attributes[:'policyLockedDateTime'] if attributes[:'policyLockedDateTime']

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

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

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  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.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#backup_retention_period_in_days ⇒ Integer

[Required] The maximum number of days to retain backups for a protected database. Specify a period ranging from a minimum 14 days to a maximum 95 days. For example, specify the value 55 if you want to retain backups for 55 days.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 39

def backup_retention_period_in_days
  @backup_retention_period_in_days
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the protection policy.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 35

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}. For more information, see {Resource Tags}[https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm]

Returns:

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


83
84
85
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 83

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user provided name for the protection policy.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 31

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


77
78
79
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 77

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The protection policy OCID.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 27

def id
  @id
end

#is_predefined_policy ⇒ BOOLEAN

[Required] Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies.

Returns:

  • (BOOLEAN) 


43
44
45
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 43

def is_predefined_policy
  @is_predefined_policy
end

#lifecycle_details ⇒ String

Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 71

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the protection policy.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 67

def lifecycle_state
  @lifecycle_state
end

#must_enforce_cloud_locality ⇒ BOOLEAN

Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.

Returns:

  • (BOOLEAN) 


52
53
54
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 52

def must_enforce_cloud_locality
  @must_enforce_cloud_locality
end

#policy_locked_date_time ⇒ String

An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 48

def policy_locked_date_time
  @policy_locked_date_time
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}. For more information, see {Resource Tags}[https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm]

Returns:

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


89
90
91
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 89

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

An RFC3339 formatted datetime string that indicates the created time for the protection policy. For example: '2020-05-22T21:10:29.600Z'.

Returns:

  • (DateTime) 


57
58
59
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 57

def time_created
  @time_created
end

#time_updated ⇒ DateTime

An RFC3339 formatted datetime string that indicates the updated time for the protection policy. For example: '2020-05-22T21:10:29.600Z'.

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 62

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'backup_retention_period_in_days': :'backupRetentionPeriodInDays',
    'is_predefined_policy': :'isPredefinedPolicy',
    'policy_locked_date_time': :'policyLockedDateTime',
    'must_enforce_cloud_locality': :'mustEnforceCloudLocality',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 114

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'backup_retention_period_in_days': :'Integer',
    'is_predefined_policy': :'BOOLEAN',
    'policy_locked_date_time': :'String',
    'must_enforce_cloud_locality': :'BOOLEAN',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 264

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    backup_retention_period_in_days == other.backup_retention_period_in_days &&
    is_predefined_policy == other.is_predefined_policy &&
    policy_locked_date_time == other.policy_locked_date_time &&
    must_enforce_cloud_locality == other.must_enforce_cloud_locality &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 307

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


287
288
289
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 287

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



296
297
298
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 296

def hash
  [id, display_name, compartment_id, backup_retention_period_in_days, is_predefined_policy, policy_locked_date_time, must_enforce_cloud_locality, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 340

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



334
335
336
 
# File 'lib/oci/recovery/models/protection_policy.rb', line 334

def to_s
  to_hash.to_s
end