Class: Kubevirt::V1AddVolumeOptions

Inherits:
ApiModelBase show all
Defined in:
lib/kubevirt/models/v1_add_volume_options.rb

Overview

AddVolumeOptions is provided when dynamically hot plugging a volume and disk

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ V1AddVolumeOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
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
99
100
101
102
103
104
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 67

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::V1AddVolumeOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Kubevirt::V1AddVolumeOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'disk')
    self.disk = attributes[:'disk']
  else
    self.disk = nil
  end

  if attributes.key?(:'dry_run')
    if (value = attributes[:'dry_run']).is_a?(Array)
      self.dry_run = value
    end
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = ''
  end

  if attributes.key?(:'volume_source')
    self.volume_source = attributes[:'volume_source']
  else
    self.volume_source = nil
  end
end

Instance Attribute Details

#diskObject

Returns the value of attribute disk.



19
20
21
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 19

def disk
  @disk
end

#dry_runObject

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed



22
23
24
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 22

def dry_run
  @dry_run
end

#nameObject

Name represents the name that will be used to map the disk to the corresponding volume. This overrides any name set inside the Disk struct itself.



25
26
27
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 25

def name
  @name
end

#volume_sourceObject

Returns the value of attribute volume_source.



27
28
29
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 27

def volume_source
  @volume_source
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



40
41
42
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 40

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



45
46
47
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 45

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



30
31
32
33
34
35
36
37
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 30

def self.attribute_map
  {
    :'disk' => :'disk',
    :'dry_run' => :'dryRun',
    :'name' => :'name',
    :'volume_source' => :'volumeSource'
  }
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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 192

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



60
61
62
63
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 60

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



50
51
52
53
54
55
56
57
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 50

def self.openapi_types
  {
    :'disk' => :'V1Disk',
    :'dry_run' => :'Array<String>',
    :'name' => :'String',
    :'volume_source' => :'V1HotplugVolumeSource'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



168
169
170
171
172
173
174
175
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      disk == o.disk &&
      dry_run == o.dry_run &&
      name == o.name &&
      volume_source == o.volume_source
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 179

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



185
186
187
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 185

def hash
  [disk, dry_run, name, volume_source].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 108

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @disk.nil?
    invalid_properties.push('invalid value for "disk", disk cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @volume_source.nil?
    invalid_properties.push('invalid value for "volume_source", volume_source cannot be nil.')
  end

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 214

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



128
129
130
131
132
133
134
# File 'lib/kubevirt/models/v1_add_volume_options.rb', line 128

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @disk.nil?
  return false if @name.nil?
  return false if @volume_source.nil?
  true
end