Class: OCI::Core::Models::BlockVolumeReplicaInfo

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

Overview

Information about the block volume replica in the destination availability domain.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BlockVolumeReplicaInfo

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

  • :block_volume_replica_id (String) —

    The value to assign to the #block_volume_replica_id property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property



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

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

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

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

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

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

  self.kms_key_id = attributes[:'kms_key_id'] if attributes[:'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) 


26
27
28
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 26

def availability_domain
  @availability_domain
end

#block_volume_replica_id ⇒ String

[Required] The block volume replica's Oracle ID (OCID).

Returns:

  • (String) 


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

def block_volume_replica_id
  @block_volume_replica_id
end

#display_name ⇒ String

[Required] 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_info.rb', line 15

def display_name
  @display_name
end

#kms_key_id ⇒ String

The OCID of the Vault service key to assign as the master encryption key for the block volume replica, see Overview of Vault service and Using Keys.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 33

def kms_key_id
  @kms_key_id
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'block_volume_replica_id': :'blockVolumeReplicaId',
    'availability_domain': :'availabilityDomain',
    'kms_key_id': :'kmsKeyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 48

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



107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 107

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

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 140

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


120
121
122
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 129

def hash
  [display_name, block_volume_replica_id, availability_domain, 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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 173

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



167
168
169
 
# File 'lib/oci/core/models/block_volume_replica_info.rb', line 167

def to_s
  to_hash.to_s
end