Class: OCI::Core::Models::UpdateVolumeDetails

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

Overview

UpdateVolumeDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateVolumeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/core/models/update_volume_details.rb', line 127

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

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

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

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

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

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

  self.vpus_per_gb = attributes[:'vpusPerGB'] if attributes[:'vpusPerGB']

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

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

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

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

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

  self.is_auto_tune_enabled = attributes[:'isAutoTuneEnabled'] unless attributes[:'isAutoTuneEnabled'].nil?

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

  self.is_auto_tune_enabled = attributes[:'is_auto_tune_enabled'] unless attributes[:'is_auto_tune_enabled'].nil?

  self.block_volume_replicas = attributes[:'blockVolumeReplicas'] if attributes[:'blockVolumeReplicas']

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

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

  self.autotune_policies = attributes[:'autotunePolicies'] if attributes[:'autotunePolicies']

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

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

  self.is_reservations_enabled = attributes[:'isReservationsEnabled'] unless attributes[:'isReservationsEnabled'].nil?

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

  self.is_reservations_enabled = attributes[:'is_reservations_enabled'] unless attributes[:'is_reservations_enabled'].nil?
end

Instance Attribute Details

#autotune_policies ⇒ Array<OCI::Core::Models::AutotunePolicy>

The list of autotune policies enabled for this volume.

Returns:



70
71
72
 
# File 'lib/oci/core/models/update_volume_details.rb', line 70

def autotune_policies
  @autotune_policies
end

#block_volume_replicas ⇒ Array<OCI::Core::Models::BlockVolumeReplicaDetails>

The list of block volume replicas that this volume will be updated to have in the specified destination availability domains.

Returns:



66
67
68
 
# File 'lib/oci/core/models/update_volume_details.rb', line 66

def block_volume_replicas
  @block_volume_replicas
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/update_volume_details.rb', line 23

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


31
32
33
 
# File 'lib/oci/core/models/update_volume_details.rb', line 31

def freeform_tags
  @freeform_tags
end

#is_auto_tune_enabled ⇒ BOOLEAN

Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.

Returns:

  • (BOOLEAN) 


60
61
62
 
# File 'lib/oci/core/models/update_volume_details.rb', line 60

def is_auto_tune_enabled
  @is_auto_tune_enabled
end

#is_reservations_enabled ⇒ BOOLEAN

When set to true, enables SCSI Persistent Reservation (SCSI PR) for the volume. For more information, see Persistent Reservations.

Returns:

  • (BOOLEAN) 


76
77
78
 
# File 'lib/oci/core/models/update_volume_details.rb', line 76

def is_reservations_enabled
  @is_reservations_enabled
end

#size_in_gbs ⇒ Integer

The size to resize the volume to in GBs. Has to be larger than the current size.

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/oci/core/models/update_volume_details.rb', line 54

def size_in_gbs
  @size_in_gbs
end

#vpus_per_gb ⇒ Integer

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

Allowed values:

  • 0: Represents Lower Cost option.

  • 10: Represents Balanced option.

  • 20: Represents Higher Performance option.

  • 30-120: Represents the Ultra High Performance option.

For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/oci/core/models/update_volume_details.rb', line 50

def vpus_per_gb
  @vpus_per_gb
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/core/models/update_volume_details.rb', line 79

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'vpus_per_gb': :'vpusPerGB',
    'size_in_gbs': :'sizeInGBs',
    'is_auto_tune_enabled': :'isAutoTuneEnabled',
    'block_volume_replicas': :'blockVolumeReplicas',
    'autotune_policies': :'autotunePolicies',
    'is_reservations_enabled': :'isReservationsEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/core/models/update_volume_details.rb', line 96

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'vpus_per_gb': :'Integer',
    'size_in_gbs': :'Integer',
    'is_auto_tune_enabled': :'BOOLEAN',
    'block_volume_replicas': :'Array<OCI::Core::Models::BlockVolumeReplicaDetails>',
    'autotune_policies': :'Array<OCI::Core::Models::AutotunePolicy>',
    'is_reservations_enabled': :'BOOLEAN'
    # 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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/core/models/update_volume_details.rb', line 195

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

  self.class == other.class &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    vpus_per_gb == other.vpus_per_gb &&
    size_in_gbs == other.size_in_gbs &&
    is_auto_tune_enabled == other.is_auto_tune_enabled &&
    block_volume_replicas == other.block_volume_replicas &&
    autotune_policies == other.autotune_policies &&
    is_reservations_enabled == other.is_reservations_enabled
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/core/models/update_volume_details.rb', line 233

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


213
214
215
 
# File 'lib/oci/core/models/update_volume_details.rb', line 213

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/oci/core/models/update_volume_details.rb', line 222

def hash
  [defined_tags, display_name, freeform_tags, vpus_per_gb, size_in_gbs, is_auto_tune_enabled, block_volume_replicas, autotune_policies, is_reservations_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/core/models/update_volume_details.rb', line 266

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



260
261
262
 
# File 'lib/oci/core/models/update_volume_details.rb', line 260

def to_s
  to_hash.to_s
end