Class: OCI::DisasterRecovery::Models::DrProtectionGroupMemberVolumeGroup

Inherits:
DrProtectionGroupMember show all
Defined in:
lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb

Overview

The properties for a volume group member of a DR protection group.

Constant Summary

Constants inherited from DrProtectionGroupMember

OCI::DisasterRecovery::Models::DrProtectionGroupMember::MEMBER_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DrProtectionGroupMember

#member_id, #member_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DrProtectionGroupMember

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DrProtectionGroupMemberVolumeGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 83

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['memberType'] = 'VOLUME_GROUP'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.destination_backup_policy_id = attributes[:'destinationBackupPolicyId'] if attributes[:'destinationBackupPolicyId']

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

  self.destination_backup_policy_id = attributes[:'destination_backup_policy_id'] if attributes[:'destination_backup_policy_id']

  self.source_volume_to_destination_encryption_key_mappings = attributes[:'sourceVolumeToDestinationEncryptionKeyMappings'] if attributes[:'sourceVolumeToDestinationEncryptionKeyMappings']

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

  self.source_volume_to_destination_encryption_key_mappings = attributes[:'source_volume_to_destination_encryption_key_mappings'] if attributes[:'source_volume_to_destination_encryption_key_mappings']

  self.common_destination_key = attributes[:'commonDestinationKey'] if attributes[:'commonDestinationKey']

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

  self.common_destination_key = attributes[:'common_destination_key'] if attributes[:'common_destination_key']

  self.destination_compartment_id = attributes[:'destinationCompartmentId'] if attributes[:'destinationCompartmentId']

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

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

Instance Attribute Details

#common_destination_key ⇒ OCI::DisasterRecovery::Models::VaultAndEncryptionKey

Returns:



35
36
37
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 35

def common_destination_key
  @common_destination_key
end

#destination_backup_policy_id ⇒ String

The OCID of the backup policy to use in the destination region. This policy will be used to create backups for this volume group after it moves the destination region.

Example: ocid1.volumebackuppolicy.oc1..uniqueID

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 18

def destination_backup_policy_id
  @destination_backup_policy_id
end

#destination_compartment_id ⇒ String

The OCID of a compartment in the destination region in which the volume group should be launched.

Example: ocid1.compartment.oc1..uniqueID

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 42

def destination_compartment_id
  @destination_compartment_id
end

#source_volume_to_destination_encryption_key_mappings ⇒ Array<OCI::DisasterRecovery::Models::SourceVolumeToDestinationEncryptionKeyMapping>

A list of mappings between source volume IDs in the volume group and customer-managed encryption keys in the destination region which will be used to encrypt the volume after it moves to the destination region.

If you add the entry for source volumes and its corresponding vault and encryption keys here, you can not use 'commonDestinationKey' for encrypting all volumes with common encryption key. Similarly, if you specify common vault and encryption key using 'commonDestinationKey', you cannot specify vaults and encryption keys individually for each volume using 'sourceVolumeToDestinationEncryptionKeyMappings'.

An entry for each volume in volume group should be added in this list. The encryption key will not be updated for the volumes that are part of volume group but missing in this list.

Returns:



32
33
34
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 32

def source_volume_to_destination_encryption_key_mappings
  @source_volume_to_destination_encryption_key_mappings
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'member_id': :'memberId',
    'member_type': :'memberType',
    'destination_backup_policy_id': :'destinationBackupPolicyId',
    'source_volume_to_destination_encryption_key_mappings': :'sourceVolumeToDestinationEncryptionKeyMappings',
    'common_destination_key': :'commonDestinationKey',
    'destination_compartment_id': :'destinationCompartmentId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'member_id': :'String',
    'member_type': :'String',
    'destination_backup_policy_id': :'String',
    'source_volume_to_destination_encryption_key_mappings': :'Array<OCI::DisasterRecovery::Models::SourceVolumeToDestinationEncryptionKeyMapping>',
    'common_destination_key': :'OCI::DisasterRecovery::Models::VaultAndEncryptionKey',
    'destination_compartment_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 125

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

  self.class == other.class &&
    member_id == other.member_id &&
    member_type == other.member_type &&
    destination_backup_policy_id == other.destination_backup_policy_id &&
    source_volume_to_destination_encryption_key_mappings == other.source_volume_to_destination_encryption_key_mappings &&
    common_destination_key == other.common_destination_key &&
    destination_compartment_id == other.destination_compartment_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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 160

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


140
141
142
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 149

def hash
  [member_id, member_type, destination_backup_policy_id, source_volume_to_destination_encryption_key_mappings, common_destination_key, destination_compartment_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 193

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



187
188
189
 
# File 'lib/oci/disaster_recovery/models/dr_protection_group_member_volume_group.rb', line 187

def to_s
  to_hash.to_s
end