class OCI::Core::Models::VolumeBackupPolicy
A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Attributes
The OCID of the compartment that contains the volume backup. @return [String]
The paired destination region for copying scheduled backups to. Example `us-ashburn-1`. See [Region Pairs](docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions.
@return [String]
[Required] A user-friendly name for the volume backup policy. Does not have to be unique and it's changeable. Avoid entering confidential information.
@return [String]
[Required] The OCID of the volume backup policy. @return [String]
[Required] The collection of schedules that this policy will apply. @return [Array<OCI::Core::Models::VolumeBackupSchedule>]
[Required] The date and time the volume backup policy was created. Format defined by [RFC3339](tools.ietf.org/html/rfc3339).
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/volume_backup_policy.rb, line 62 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'id': :'id', 'schedules': :'schedules', 'destination_region': :'destinationRegion', 'time_created': :'timeCreated', 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'freeform_tags': :'freeformTags' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [Array<OCI::Core::Models::VolumeBackupSchedule>] :schedules The value to assign to the {#schedules} property @option attributes [String] :destination_region The value to assign to the {#destination_region} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
# File lib/oci/core/models/volume_backup_policy.rb, line 107 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.id = attributes[:'id'] if attributes[:'id'] self.schedules = attributes[:'schedules'] if attributes[:'schedules'] self.destination_region = attributes[:'destinationRegion'] if attributes[:'destinationRegion'] raise 'You cannot provide both :destinationRegion and :destination_region' if attributes.key?(:'destinationRegion') && attributes.key?(:'destination_region') self.destination_region = attributes[:'destination_region'] if attributes[:'destination_region'] 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.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.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.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'] end
Attribute type mapping.
# File lib/oci/core/models/volume_backup_policy.rb, line 78 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'id': :'String', 'schedules': :'Array<OCI::Core::Models::VolumeBackupSchedule>', 'destination_region': :'String', 'time_created': :'DateTime', 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'freeform_tags': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/volume_backup_policy.rb, line 161 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && id == other.id && schedules == other.schedules && destination_region == other.destination_region && time_created == other.time_created && compartment_id == other.compartment_id && defined_tags == other.defined_tags && freeform_tags == other.freeform_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/volume_backup_policy.rb, line 198 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/volume_backup_policy.rb, line 178 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/volume_backup_policy.rb, line 187 def hash [display_name, id, schedules, destination_region, time_created, compartment_id, defined_tags, freeform_tags].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/volume_backup_policy.rb, line 231 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/volume_backup_policy.rb, line 225 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/core/models/volume_backup_policy.rb, line 248 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end