Class: OCI::FileStorage::Models::FilesystemSnapshotPolicy
- Inherits:
-
Object
- Object
- OCI::FileStorage::Models::FilesystemSnapshotPolicy
- Defined in:
- lib/oci/file_storage/models/filesystem_snapshot_policy.rb
Overview
A file system snapshot policy is used to automate snapshot creation and deletion. It contains a list of snapshot schedules that define the frequency of snapshot creation for the associated file systems and the retention period of snapshots taken on schedule.
For more information, see Snapshot Scheduling.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
[Required] The availability domain that the file system snapshot policy is in.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the file system snapshot policy.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the file system snapshot policy.
-
#lifecycle_state ⇒ String
[Required] The current state of the file system snapshot policy.
-
#policy_prefix ⇒ String
The prefix to apply to all snapshots created by this policy.
-
#schedules ⇒ Array<OCI::FileStorage::Models::SnapshotSchedule>
The list of associated snapshot schedules.
-
#time_created ⇒ DateTime
[Required] The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format.
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 = {}) ⇒ FilesystemSnapshotPolicy
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 = {}) ⇒ FilesystemSnapshotPolicy
Initializes the object
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 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 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 143 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.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.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain'] raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain') self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain'] self.id = attributes[:'id'] if attributes[:'id'] 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.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.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.policy_prefix = attributes[:'policyPrefix'] if attributes[:'policyPrefix'] raise 'You cannot provide both :policyPrefix and :policy_prefix' if attributes.key?(:'policyPrefix') && attributes.key?(:'policy_prefix') self.policy_prefix = attributes[:'policy_prefix'] if attributes[:'policy_prefix'] self.schedules = attributes[:'schedules'] if attributes[:'schedules'] 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'] end |
Instance Attribute Details
#availability_domain ⇒ String
[Required] The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.
Example: Uocm:PHX-AD-2
38 39 40 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 38 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the file system snapshot policy.
31 32 33 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 31 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. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
89 90 91 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 89 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: policy1
62 63 64 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 62 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}
82 83 84 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 82 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the file system snapshot policy.
42 43 44 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 42 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the file system snapshot policy.
46 47 48 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 46 def lifecycle_state @lifecycle_state end |
#policy_prefix ⇒ String
The prefix to apply to all snapshots created by this policy.
Example: acme
69 70 71 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 69 def policy_prefix @policy_prefix end |
#schedules ⇒ Array<OCI::FileStorage::Models::SnapshotSchedule>
The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
74 75 76 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 74 def schedules @schedules end |
#time_created ⇒ DateTime
[Required] The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format.
Example: 2016-08-25T21:10:29.600Z
54 55 56 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 54 def time_created @time_created 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 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 92 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'availability_domain': :'availabilityDomain', 'id': :'id', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'display_name': :'displayName', 'policy_prefix': :'policyPrefix', 'schedules': :'schedules', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 110 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'availability_domain': :'String', 'id': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'display_name': :'String', 'policy_prefix': :'String', 'schedules': :'Array<OCI::FileStorage::Models::SnapshotSchedule>', '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.
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 222 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && availability_domain == other.availability_domain && id == other.id && lifecycle_state == other.lifecycle_state && time_created == other.time_created && display_name == other.display_name && policy_prefix == other.policy_prefix && schedules == other.schedules && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 261 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
241 242 243 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 241 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
250 251 252 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 250 def hash [compartment_id, availability_domain, id, lifecycle_state, time_created, display_name, policy_prefix, schedules, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
294 295 296 297 298 299 300 301 302 303 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 294 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
288 289 290 |
# File 'lib/oci/file_storage/models/filesystem_snapshot_policy.rb', line 288 def to_s to_hash.to_s end |