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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeBackupPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 34

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}

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  if attributes[:'display_name']
    self.display_name = attributes[:'display_name']
  end

  if attributes[:'id']
    self.id = attributes[:'id']
  end

  if attributes[:'schedules']
    self.schedules = attributes[:'schedules']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  if attributes[:'time_created']
    self.time_created = attributes[:'time_created']
  end

end

Instance Attribute Details

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

Returns:

  • (String) 


12
13
14
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 12

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the volume backup policy.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 16

def id
  @id
end

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

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

Returns:



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

def schedules
  @schedules
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


25
26
27
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 25

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



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

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      schedules == other_object.schedules &&
      time_created == other_object.time_created
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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 96

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


83
84
85
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 83

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



89
90
91
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 89

def hash
  [display_name, id, schedules, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 121

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



115
116
117
 
# File 'lib/oci/core/models/volume_backup_policy.rb', line 115

def to_s
  to_hash.to_s
end