Class: OCI::Core::Models::VolumeSourceDetails

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

Overview

Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeSourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String)

    The value to assign to the #type property



61
62
63
64
65
66
67
68
# File 'lib/oci/core/models/volume_source_details.rb', line 61

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

Instance Attribute Details

#typeString

This attribute is required.

Returns:

  • (String)


17
18
19
# File 'lib/oci/core/models/volume_source_details.rb', line 17

def type
  @type
end

Class Method Details

.attribute_mapObject

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



20
21
22
23
24
25
26
# File 'lib/oci/core/models/volume_source_details.rb', line 20

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



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

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Core::Models::VolumeSourceFromBlockVolumeReplicaDetails' if type == 'blockVolumeReplica'
  return 'OCI::Core::Models::VolumeSourceFromVolumeDetails' if type == 'volume'
  return 'OCI::Core::Models::VolumeSourceFromVolumeBackupDetails' if type == 'volumeBackup'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Core::Models::VolumeSourceDetails'
end

.swagger_typesObject

Attribute type mapping.



29
30
31
32
33
34
35
# File 'lib/oci/core/models/volume_source_details.rb', line 29

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'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



77
78
79
80
81
82
# File 'lib/oci/core/models/volume_source_details.rb', line 77

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

  self.class == other.class &&
    type == other.type
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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/oci/core/models/volume_source_details.rb', line 107

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


87
88
89
# File 'lib/oci/core/models/volume_source_details.rb', line 87

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



96
97
98
# File 'lib/oci/core/models/volume_source_details.rb', line 96

def hash
  [type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



140
141
142
143
144
145
146
147
148
149
# File 'lib/oci/core/models/volume_source_details.rb', line 140

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



134
135
136
# File 'lib/oci/core/models/volume_source_details.rb', line 134

def to_s
  to_hash.to_s
end