Class: OCI::Recovery::Models::CreateProtectionPolicyDetails

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

Overview

Describes the parameters required to create a custom protection policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateProtectionPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 99

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.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.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.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.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.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.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']
end

Instance Attribute Details

#backup_retention_period_in_days ⇒ Integer

[Required] The maximum number of days to retain backups for a protected database.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 17

def backup_retention_period_in_days
  @backup_retention_period_in_days
end

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 21

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>>) 


54
55
56
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 54

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 13

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>) 


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

def freeform_tags
  @freeform_tags
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. This parameter is applicable if your Oracle Database runs in a different cloud service environment, such as Microsoft Azure. If you set the mustEnforceCloudLocality parameter to TRUE, then Recovery Service stores the database backups locally in the same cloud service environment where the database resides. For example, if your Oracle Database is provisioned on Microsoft Azure, then Recovery Service stores the database backups in Azure. Note: You cannot change the mustEnforceCloudLocality setting for a protection policy after you create it.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 30

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.

  • The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups.

  • Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date.

  • For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to '2023-08-15T21:00:00.600Z' (Aug 15, 2023, 9:00 pm), or greater.

  • During the 14-day delay period, you can either increase or decrease the retention period in the policy.

  • However, you are only allowed to increase the retention period on or after the retention lock date.

  • You cannot change the value of policyLockedDateTime if the retention lock is already in effect.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 42

def policy_locked_date_time
  @policy_locked_date_time
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'backup_retention_period_in_days': :'backupRetentionPeriodInDays',
    'compartment_id': :'compartmentId',
    'must_enforce_cloud_locality': :'mustEnforceCloudLocality',
    'policy_locked_date_time': :'policyLockedDateTime',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'backup_retention_period_in_days': :'Integer',
    'compartment_id': :'String',
    'must_enforce_cloud_locality': :'BOOLEAN',
    'policy_locked_date_time': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 157

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

  self.class == other.class &&
    display_name == other.display_name &&
    backup_retention_period_in_days == other.backup_retention_period_in_days &&
    compartment_id == other.compartment_id &&
    must_enforce_cloud_locality == other.must_enforce_cloud_locality &&
    policy_locked_date_time == other.policy_locked_date_time &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 193

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


173
174
175
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 173

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 182

def hash
  [display_name, backup_retention_period_in_days, compartment_id, must_enforce_cloud_locality, policy_locked_date_time, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 226

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



220
221
222
 
# File 'lib/oci/recovery/models/create_protection_policy_details.rb', line 220

def to_s
  to_hash.to_s
end