Class: Kubevirt::V1KernelBootContainer

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

Overview

If set, the VM will be booted from the defined kernel / initrd.

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ V1KernelBootContainer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::V1KernelBootContainer` 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::V1KernelBootContainer`. 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?(:'image')
    self.image = attributes[:'image']
  else
    self.image = ''
  end

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

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

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

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

Instance Attribute Details

#imageObject

Image that contains initrd / kernel files.



20
21
22
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 20

def image
  @image
end

#image_pull_policyObject

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: kubernetes.io/docs/concepts/containers/images#updating-images Possible enum values: - ‘"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - `"IfNotPresent"` means that kubelet pulls if the image isn’t present on disk. Container will fail if the image isn’t present and the pull fails. - ‘"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn’t present



23
24
25
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 23

def image_pull_policy
  @image_pull_policy
end

#image_pull_secretObject

ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.



26
27
28
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 26

def image_pull_secret
  @image_pull_secret
end

#initrd_pathObject

the fully-qualified path to the ramdisk image in the host OS



29
30
31
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 29

def initrd_path
  @initrd_path
end

#kernel_pathObject

The fully-qualified path to the kernel image in the host OS



32
33
34
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 32

def kernel_path
  @kernel_path
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



68
69
70
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



73
74
75
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 57

def self.attribute_map
  {
    :'image' => :'image',
    :'image_pull_policy' => :'imagePullPolicy',
    :'image_pull_secret' => :'imagePullSecret',
    :'initrd_path' => :'initrdPath',
    :'kernel_path' => :'kernelPath'
  }
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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 202

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



89
90
91
92
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 89

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

.openapi_typesObject

Attribute type mapping.



78
79
80
81
82
83
84
85
86
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 78

def self.openapi_types
  {
    :'image' => :'String',
    :'image_pull_policy' => :'String',
    :'image_pull_secret' => :'String',
    :'initrd_path' => :'String',
    :'kernel_path' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



177
178
179
180
181
182
183
184
185
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      image == o.image &&
      image_pull_policy == o.image_pull_policy &&
      image_pull_secret == o.image_pull_secret &&
      initrd_path == o.initrd_path &&
      kernel_path == o.kernel_path
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 189

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



195
196
197
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 195

def hash
  [image, image_pull_policy, image_pull_secret, initrd_path, kernel_path].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



135
136
137
138
139
140
141
142
143
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 135

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @image.nil?
    invalid_properties.push('invalid value for "image", image 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



224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 224

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



147
148
149
150
151
152
153
# File 'lib/kubevirt/models/v1_kernel_boot_container.rb', line 147

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @image.nil?
  image_pull_policy_validator = EnumAttributeValidator.new('String', ["Always", "IfNotPresent", "Never"])
  return false unless image_pull_policy_validator.valid?(@image_pull_policy)
  true
end