Class: OCI::Recovery::Models::ProtectionPolicySummary
- Inherits:
-
Object
- Object
- OCI::Recovery::Models::ProtectionPolicySummary
- Defined in:
- lib/oci/recovery/models/protection_policy_summary.rb
Overview
Recovery Service enables policy driven backup storage management.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about access control and compartments, see Overview of the Identity Service.
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
-
#backup_retention_period_in_days ⇒ Integer
[Required] The maximum number of days to retain backups for a protected database.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the protection policy.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user provided name for the protection policy.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The protection policy OCID.
-
#is_predefined_policy ⇒ BOOLEAN
[Required] Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy.
-
#lifecycle_details ⇒ String
Detailed description about the current lifecycle state of the protection policy.
-
#lifecycle_state ⇒ String
The current state of the Protection Policy.
-
#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.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
The time the Protection Policy was created.
-
#time_updated ⇒ DateTime
The time the Protection Policy was updated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ProtectionPolicySummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ ProtectionPolicySummary
Initializes the object
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 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 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 148 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = 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.
42 43 44 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 42 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.
38 39 40 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 38 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]
79 80 81 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 79 def @defined_tags end |
#display_name ⇒ String
A user provided name for the protection policy.
34 35 36 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 34 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\"}
73 74 75 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 73 def @freeform_tags end |
#id ⇒ String
[Required] The protection policy OCID.
30 31 32 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 30 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.
46 47 48 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 46 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.
67 68 69 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 67 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the Protection Policy.
63 64 65 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 63 def lifecycle_state @lifecycle_state 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.
51 52 53 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 51 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]
85 86 87 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 85 def @system_tags end |
#time_created ⇒ DateTime
The time the Protection Policy was created. An RFC3339 formatted datetime string
55 56 57 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 55 def time_created @time_created end |
#time_updated ⇒ DateTime
The time the Protection Policy was updated. An RFC3339 formatted datetime string
59 60 61 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 59 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 88 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', '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.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 109 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', '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.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 249 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 && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 291 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
271 272 273 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 271 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
280 281 282 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 280 def hash [id, display_name, compartment_id, backup_retention_period_in_days, is_predefined_policy, policy_locked_date_time, time_created, time_updated, lifecycle_state, lifecycle_details, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
324 325 326 327 328 329 330 331 332 333 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 324 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
318 319 320 |
# File 'lib/oci/recovery/models/protection_policy_summary.rb', line 318 def to_s to_hash.to_s end |