Class: OCI::Core::Models::VolumeBackupPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/volume_backup_policy.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeBackupPolicy

Initializes the object

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :schedules (Array<OCI::Core::Models::VolumeBackupSchedule>) —

    The value to assign to the #schedules property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #freeform_tags property



97
98
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
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 97

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment that contains the volume backup.



36
37
38
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 36

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`



44
45
46
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 44

def defined_tags
  @defined_tags
end

#display_name ⇒ 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.



19
20
21
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 19

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`



52
53
54
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 52

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the volume backup policy.



23
24
25
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 23

def id
  @id
end

#schedules ⇒ Array<OCI::Core::Models::VolumeBackupSchedule>

[Required] The collection of schedules that this policy will apply.



27
28
29
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 27

def schedules
  @schedules
end

#time_created ⇒ DateTime

[Required] The date and time the volume backup policy was created. Format defined by RFC3339.



32
33
34
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 32

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'id': :'id',
    'schedules': :'schedules',
    'time_created': :'timeCreated',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'id': :'String',
    'schedules': :'Array<OCI::Core::Models::VolumeBackupSchedule>',
    'time_created': :'DateTime',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 145

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

  self.class == other.class &&
    display_name == other.display_name &&
    id == other.id &&
    schedules == other.schedules &&
    time_created == other.time_created &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 181

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

See Also:

  • `==` method


161
162
163
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 161

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



170
171
172
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 170

def hash
  [display_name, id, schedules, time_created, compartment_id, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 214

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



208
209
210
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 208

def to_s
  to_hash.to_s
end