Class: Kubernetes::V1VolumeMount

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

Overview

VolumeMount describes a mounting of a Volume within a container.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1VolumeMount

Initializes the object



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 57

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

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

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

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

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

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

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

Instance Attribute Details

#mount_path ⇒ Object

Path within the container at which the volume should be mounted. Must not contain ‘:’.



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

def mount_path
  @mount_path
end

#mount_propagation ⇒ Object

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.



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

def mount_propagation
  @mount_propagation
end

#name ⇒ Object

This must match the Name of a Volume.



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

def name
  @name
end

#read_only ⇒ Object

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.



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

def read_only
  @read_only
end

#sub_path ⇒ Object

Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).



31
32
33
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 31

def sub_path
  @sub_path
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 34

def self.attribute_map
  {
    mount_path: :mountPath,
    mount_propagation: :mountPropagation,
    name: :name,
    read_only: :readOnly,
    sub_path: :subPath
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 45

def self.swagger_types
  {
    mount_path: :String,
    mount_propagation: :String,
    name: :String,
    read_only: :BOOLEAN,
    sub_path: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 98

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

  self.class == other.class &&
    mount_path == other.mount_path &&
    mount_propagation == other.mount_propagation &&
    name == other.name &&
    read_only == other.read_only &&
    sub_path == other.sub_path
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 215

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 124

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

See Also:

  • `==` method


111
112
113
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



117
118
119
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 117

def hash
  [mount_path, mount_propagation, name, read_only, sub_path].hash
end

#list_invalid_properties ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 76

def list_invalid_properties
  invalid_properties = []
  if @mount_path.nil?
    invalid_properties.push("invalid value for 'mount_path', mount_path cannot be nil.")
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



194
195
196
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 194

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



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

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



188
189
190
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 188

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



89
90
91
92
93
94
 
# File 'lib/kubernetes/models/v1_volume_mount.rb', line 89

def valid?
  return false if @mount_path.nil?
  return false if @name.nil?

  true
end