Class: Kubevirt::V1ConfigMapVolumeSource

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

Overview

ConfigMapVolumeSource adapts a ConfigMap into a volume. More info: kubernetes.io/docs/concepts/storage/volumes/#configmap

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
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
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 64

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

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

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

Instance Attribute Details

#name ⇒ Object

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#names



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

def name
  @name
end

#optional ⇒ Object

Specify whether the ConfigMap or it’s keys must be defined



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

def optional
  @optional
end

#volume_label ⇒ Object

The volume label of the resulting disk inside the VMI. Different bootstrapping mechanisms require different values. Typical values are "cidata" (cloud-init), "config-2" (cloud-init) or "OEMDRV" (kickstart).



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

def volume_label
  @volume_label
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 29

def self.attribute_map
  {
    :'name' => :'name',
    :'optional' => :'optional',
    :'volume_label' => :'volumeLabel'
  }
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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 133

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_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 48

def self.openapi_types
  {
    :'name' => :'String',
    :'optional' => :'Boolean',
    :'volume_label' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



110
111
112
113
114
115
116
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 110

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      optional == o.optional &&
      volume_label == o.volume_label
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


120
121
122
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 120

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



126
127
128
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 126

def hash
  [name, optional, volume_label].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



95
96
97
98
99
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 95

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 155

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



103
104
105
106
 
# File 'lib/kubevirt/models/v1_config_map_volume_source.rb', line 103

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end