Class: OracleBMC::Core::Models::VolumeBackup

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/volume_backup.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_FAULTY = 'FAULTY',
LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeBackup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 60

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[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'sizeInMBs']
    self.size_in_m_bs = attributes[:'sizeInMBs']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
  if attributes[:'timeRequestReceived']
    self.time_request_received = attributes[:'timeRequestReceived']
  end
  
  if attributes[:'uniqueSizeInMbs']
    self.unique_size_in_mbs = attributes[:'uniqueSizeInMbs']
  end
  
  if attributes[:'volumeId']
    self.volume_id = attributes[:'volumeId']
  end
  
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment that contains the volume backup.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 17

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name for the volume backup. Does not have to be unique and it’s changeable.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 21

def display_name
  @display_name
end

#id ⇒ String

The OCID of the volume backup.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 25

def id
  @id
end

#lifecycle_state ⇒ String

The current state of a volume backup.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 29

def lifecycle_state
  @lifecycle_state
end

#size_in_m_bs ⇒ Integer

The size of the volume, in MBs.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 34

def size_in_m_bs
  @size_in_m_bs
end

#time_created ⇒ DateTime

The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 40

def time_created
  @time_created
end

#time_request_received ⇒ DateTime

The date and time the request to create the volume backup was received. Format defined by RFC3339.

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 45

def time_request_received
  @time_request_received
end

#unique_size_in_mbs ⇒ Integer

The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental.

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 51

def unique_size_in_mbs
  @unique_size_in_mbs
end

#volume_id ⇒ String

The OCID of the volume.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 55

def volume_id
  @volume_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 116

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      size_in_m_bs == other_object.size_in_m_bs &&
      time_created == other_object.time_created &&
      time_request_received == other_object.time_request_received &&
      unique_size_in_mbs == other_object.unique_size_in_mbs &&
      volume_id == other_object.volume_id
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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 145

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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


132
133
134
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 132

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



138
139
140
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 138

def hash
  [compartment_id, display_name, id, lifecycle_state, size_in_m_bs, time_created, time_request_received, unique_size_in_mbs, volume_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



170
171
172
173
174
175
176
177
178
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 170

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



164
165
166
 
# File 'lib/oraclebmc/core/models/volume_backup.rb', line 164

def to_s
  to_hash.to_s
end