Class: Kubernetes::V1ConfigMapVolumeSource

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1_config_map_volume_source.rb

Overview

Adapts a ConfigMap into a volume. The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1ConfigMapVolumeSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 52

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

  self.default_mode = attributes[:defaultMode] if attributes.key?(:defaultMode)

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

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

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

Instance Attribute Details

#default_mode ⇒ Object

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.



19
20
21
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 19

def default_mode
  @default_mode
end

#items ⇒ Object

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.



22
23
24
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 22

def items
  @items
end

#name ⇒ Object

Name of the referent. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#names



25
26
27
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 25

def name
  @name
end

#optional ⇒ Object

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



28
29
30
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 28

def optional
  @optional
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 31

def self.attribute_map
  {
    default_mode: :defaultMode,
    items: :items,
    name: :name,
    optional: :optional
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 41

def self.swagger_types
  {
    default_mode: :Integer,
    items: :'Array<V1KeyToPath>',
    name: :String,
    optional: :BOOLEAN
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



83
84
85
86
87
88
89
90
91
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 83

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

  self.class == other.class &&
    default_mode == other.default_mode &&
    items == other.items &&
    name == other.name &&
    optional == other.optional
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 132

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Kubernetes.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 199

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


95
96
97
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 95

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



101
102
103
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 101

def hash
  [default_mode, items, name, optional].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



71
72
73
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 71

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 178

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 184

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

    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



172
173
174
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 172

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



77
78
79
 
# File 'lib/kubernetes/models/v1_config_map_volume_source.rb', line 77

def valid?
  true
end