Class: Zilla::IoK8sApiStorageV1CSINodeDriver

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb

Overview

CSINodeDriver holds information about the specification of one CSI driver installed on a node

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiStorageV1CSINodeDriver

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
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
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 62

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiStorageV1CSINodeDriver` initialize method'
  end

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

    h[k.to_sym] = v
  end

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

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

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

  return unless attributes.key?(:topology_keys)
  return unless (value = attributes[:topology_keys]).is_a?(Array)

  self.topology_keys = value
end

Instance Attribute Details

#allocatable ⇒ Object

Returns the value of attribute allocatable.



19
20
21
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 19

def allocatable
  @allocatable
end

#name ⇒ Object

This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.



22
23
24
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 22

def name
  @name
end

#node_id ⇒ Object

nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.



25
26
27
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 25

def node_id
  @node_id
end

#topology_keys ⇒ Object

topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.



28
29
30
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 28

def topology_keys
  @topology_keys
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 41

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    allocatable: :allocatable,
    name: :name,
    node_id: :nodeID,
    topology_keys: :topologyKeys
  }
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



137
138
139
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 137

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 46

def self.openapi_types
  {
    allocatable: :IoK8sApiStorageV1VolumeNodeResources,
    name: :String,
    node_id: :String,
    topology_keys: :'Array<String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



112
113
114
115
116
117
118
119
120
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 112

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

  self.class == other.class &&
    allocatable == other.allocatable &&
    name == other.name &&
    node_id == other.node_id &&
    topology_keys == other.topology_keys
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 171

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Zilla.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 242

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 144

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

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{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[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


124
125
126
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



130
131
132
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 130

def hash
  [allocatable, name, node_id, topology_keys].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



92
93
94
95
96
97
98
99
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 92

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

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

  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



218
219
220
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 218

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



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

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



212
213
214
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 212

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



103
104
105
106
107
108
 
# File 'lib/zilla/models/io_k8s_api_storage_v1_csi_node_driver.rb', line 103

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

  true
end