Class: Kubernetes::V1StorageClass

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

Overview

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1StorageClass

Initializes the object



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 82

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:volumeBindingMode)

  self.volume_binding_mode = attributes[:volumeBindingMode]
end

Instance Attribute Details

#allow_volume_expansion ⇒ Object

AllowVolumeExpansion shows whether the storage class allow volume expand



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

def allow_volume_expansion
  @allow_volume_expansion
end

#allowed_topologies ⇒ Object

Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.



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

def allowed_topologies
  @allowed_topologies
end

#api_version ⇒ Object

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: git.k8s.io/community/contributors/devel/api-conventions.md#resources



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

def api_version
  @api_version
end

#kind ⇒ Object

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds



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

def kind
  @kind
end

#metadata ⇒ Object

Standard object’s metadata. More info: git.k8s.io/community/contributors/devel/api-conventions.md#metadata



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

def metadata
  @metadata
end

#mount_options ⇒ Object

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.



34
35
36
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 34

def mount_options
  @mount_options
end

#parameters ⇒ Object

Parameters holds the parameters for the provisioner that should create volumes of this storage class.



37
38
39
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 37

def parameters
  @parameters
end

#provisioner ⇒ Object

Provisioner indicates the type of the provisioner.



40
41
42
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 40

def provisioner
  @provisioner
end

#reclaim_policy ⇒ Object

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.



43
44
45
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 43

def reclaim_policy
  @reclaim_policy
end

#volume_binding_mode ⇒ Object

VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.



46
47
48
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 46

def volume_binding_mode
  @volume_binding_mode
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 49

def self.attribute_map
  {
    allow_volume_expansion: :allowVolumeExpansion,
    allowed_topologies: :allowedTopologies,
    api_version: :apiVersion,
    kind: :kind,
    metadata: :metadata,
    mount_options: :mountOptions,
    parameters: :parameters,
    provisioner: :provisioner,
    reclaim_policy: :reclaimPolicy,
    volume_binding_mode: :volumeBindingMode
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 65

def self.swagger_types
  {
    allow_volume_expansion: :BOOLEAN,
    allowed_topologies: :'Array<V1TopologySelectorTerm>',
    api_version: :String,
    kind: :String,
    metadata: :V1ObjectMeta,
    mount_options: :'Array<String>',
    parameters: :'Hash<String, String>',
    provisioner: :String,
    reclaim_policy: :String,
    volume_binding_mode: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 140

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

  self.class == other.class &&
    allow_volume_expansion == other.allow_volume_expansion &&
    allowed_topologies == other.allowed_topologies &&
    api_version == other.api_version &&
    kind == other.kind &&
    metadata == other.metadata &&
    mount_options == other.mount_options &&
    parameters == other.parameters &&
    provisioner == other.provisioner &&
    reclaim_policy == other.reclaim_policy &&
    volume_binding_mode == other.volume_binding_mode
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 196

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 263

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 172

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


158
159
160
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



164
165
166
167
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 164

def hash
  [allow_volume_expansion, allowed_topologies, api_version, kind, metadata, mount_options,
   parameters, provisioner, reclaim_policy, volume_binding_mode].hash
end

#list_invalid_properties ⇒ Object

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



121
122
123
124
125
126
127
128
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 121

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



242
243
244
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 242

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 248

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



236
237
238
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 236

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



132
133
134
135
136
 
# File 'lib/kubernetes/models/v1_storage_class.rb', line 132

def valid?
  return false if @provisioner.nil?

  true
end