Class: OCI::Core::Models::BlockVolumeReplicaDetails

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

Overview

Contains the details for the block volume replica

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BlockVolumeReplicaDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :xrr_kms_key_id (String) —

    The value to assign to the #xrr_kms_key_id property



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 63

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.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.xrr_kms_key_id = attributes[:'xrrKmsKeyId'] if attributes[:'xrrKmsKeyId']

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

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain of the block volume replica.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 22

def availability_domain
  @availability_domain
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 15

def display_name
  @display_name
end

#xrr_kms_key_id ⇒ String

The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 30

def xrr_kms_key_id
  @xrr_kms_key_id
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'availability_domain': :'availabilityDomain',
    'xrr_kms_key_id': :'xrrKmsKeyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'availability_domain': :'String',
    'xrr_kms_key_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



95
96
97
98
99
100
101
102
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 95

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

  self.class == other.class &&
    display_name == other.display_name &&
    availability_domain == other.availability_domain &&
    xrr_kms_key_id == other.xrr_kms_key_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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 127

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


107
108
109
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 116

def hash
  [display_name, availability_domain, xrr_kms_key_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 160

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



154
155
156
 
# File 'lib/oci/core/models/block_volume_replica_details.rb', line 154

def to_s
  to_hash.to_s
end