Class: OCI::Core::Models::CreateVolumeDetails

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVolumeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
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
# File 'lib/oci/core/models/create_volume_details.rb', line 51

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

  if attributes[:'sizeInGBs']
    self.size_in_gbs = attributes[:'sizeInGBs']
  end

  if attributes[:'sizeInMBs']
    self.size_in_mbs = attributes[:'sizeInMBs']
  end

  if attributes[:'sourceDetails']
    self.source_details = attributes[:'sourceDetails']
  end

  if attributes[:'volumeBackupId']
    self.volume_backup_id = attributes[:'volumeBackupId']
  end

end

Instance Attribute Details

#availability_domainString

The Availability Domain of the volume.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String)


12
13
14
# File 'lib/oci/core/models/create_volume_details.rb', line 12

def availability_domain
  @availability_domain
end

#compartment_idString

The OCID of the compartment that contains the volume.

Returns:

  • (String)


16
17
18
# File 'lib/oci/core/models/create_volume_details.rb', line 16

def compartment_id
  @compartment_id
end

#display_nameString

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

Returns:

  • (String)


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

def display_name
  @display_name
end

#size_in_gbsInteger

The size of the volume in GBs.

Returns:

  • (Integer)


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

def size_in_gbs
  @size_in_gbs
end

#size_in_mbsInteger

The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.

Returns:

  • (Integer)


32
33
34
# File 'lib/oci/core/models/create_volume_details.rb', line 32

def size_in_mbs
  @size_in_mbs
end

#source_detailsOCI::Core::Models::VolumeSourceDetails

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.



39
40
41
# File 'lib/oci/core/models/create_volume_details.rb', line 39

def source_details
  @source_details
end

#volume_backup_idString

The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.

Returns:

  • (String)


46
47
48
# File 'lib/oci/core/models/create_volume_details.rb', line 46

def volume_backup_id
  @volume_backup_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object)

    to be compared



89
90
91
92
93
94
95
96
97
98
99
# File 'lib/oci/core/models/create_volume_details.rb', line 89

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      size_in_gbs == other_object.size_in_gbs &&
      size_in_mbs == other_object.size_in_mbs &&
      source_details == other_object.source_details &&
      volume_backup_id == other_object.volume_backup_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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/oci/core/models/create_volume_details.rb', line 116

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| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", 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_object) ⇒ Boolean

Parameters:

  • other_object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


103
104
105
# File 'lib/oci/core/models/create_volume_details.rb', line 103

def eql?(other_object)
  self == other_object
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



109
110
111
# File 'lib/oci/core/models/create_volume_details.rb', line 109

def hash
  [availability_domain, compartment_id, display_name, size_in_gbs, size_in_mbs, source_details, volume_backup_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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



135
136
137
# File 'lib/oci/core/models/create_volume_details.rb', line 135

def to_s
  to_hash.to_s
end