Class: Kubernetes::V1PersistentVolumeClaimSpec

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

Overview

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1PersistentVolumeClaimSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 67

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?(:accessModes) && (value = attributes[:accessModes]).is_a?(Array)
    self.access_modes = value
  end

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

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

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

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

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

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

Instance Attribute Details

#access_modes ⇒ Object

AccessModes contains the desired access modes the volume should have. More info: kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1



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

def access_modes
  @access_modes
end

#data_source ⇒ Object

This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.



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

def data_source
  @data_source
end

#resources ⇒ Object

Resources represents the minimum resources the volume should have. More info: kubernetes.io/docs/concepts/storage/persistent-volumes#resources



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

def resources
  @resources
end

#selector ⇒ Object

A label query over volumes to consider for binding.



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

def selector
  @selector
end

#storage_class_name ⇒ Object

Name of the StorageClass required by the claim. More info: kubernetes.io/docs/concepts/storage/persistent-volumes#class-1



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

def storage_class_name
  @storage_class_name
end

#volume_mode ⇒ Object

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature.



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

def volume_mode
  @volume_mode
end

#volume_name ⇒ Object

VolumeName is the binding reference to the PersistentVolume backing this claim.



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

def volume_name
  @volume_name
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 40

def self.attribute_map
  {
    access_modes: :accessModes,
    data_source: :dataSource,
    resources: :resources,
    selector: :selector,
    storage_class_name: :storageClassName,
    volume_mode: :volumeMode,
    volume_name: :volumeName
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 53

def self.swagger_types
  {
    access_modes: :'Array<String>',
    data_source: :V1TypedLocalObjectReference,
    resources: :V1ResourceRequirements,
    selector: :V1LabelSelector,
    storage_class_name: :String,
    volume_mode: :String,
    volume_name: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 104

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

  self.class == other.class &&
    access_modes == other.access_modes &&
    data_source == other.data_source &&
    resources == other.resources &&
    selector == other.selector &&
    storage_class_name == other.storage_class_name &&
    volume_mode == other.volume_mode &&
    volume_name == other.volume_name
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



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
185
186
187
188
189
190
191
192
193
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 157

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



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

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



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

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


119
120
121
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
128
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 125

def hash
  [access_modes, data_source, resources, selector, storage_class_name, volume_mode,
   volume_name].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



92
93
94
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 92

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



203
204
205
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 203

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



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 209

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



197
198
199
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 197

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



98
99
100
 
# File 'lib/kubernetes/models/v1_persistent_volume_claim_spec.rb', line 98

def valid?
  true
end