Class: Zilla::IoK8sApiCoreV1PersistentVolumeClaimStatus

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

Overview

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiCoreV1PersistentVolumeClaimStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
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
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 73

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiCoreV1PersistentVolumeClaimStatus` 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::IoK8sApiCoreV1PersistentVolumeClaimStatus`. 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

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

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

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

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

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

  return unless attributes.key?(:resize_status)

  self.resize_status = attributes[:resize_status]
end

Instance Attribute Details

#access_modes ⇒ Object

accessModes contains the actual access modes the volume backing the PVC has. More info: kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1



20
21
22
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 20

def access_modes
  @access_modes
end

#allocated_resources ⇒ Object

allocatedResources is the storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.



23
24
25
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 23

def allocated_resources
  @allocated_resources
end

#capacity ⇒ Object

capacity represents the actual resources of the underlying volume.



26
27
28
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 26

def capacity
  @capacity
end

#conditions ⇒ Object

conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to ‘ResizeStarted’.



29
30
31
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 29

def conditions
  @conditions
end

#phase ⇒ Object

phase represents the current phase of PersistentVolumeClaim.



32
33
34
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 32

def phase
  @phase
end

#resize_status ⇒ Object

resizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.



35
36
37
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 35

def resize_status
  @resize_status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 38

def self.attribute_map
  {
    access_modes: :accessModes,
    allocated_resources: :allocatedResources,
    capacity: :capacity,
    conditions: :conditions,
    phase: :phase,
    resize_status: :resizeStatus
  }
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



153
154
155
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 153

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 55

def self.openapi_types
  {
    access_modes: :'Array<String>',
    allocated_resources: :'Hash<String, String>',
    capacity: :'Hash<String, String>',
    conditions: :'Array<IoK8sApiCoreV1PersistentVolumeClaimCondition>',
    phase: :String,
    resize_status: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 126

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

  self.class == other.class &&
    access_modes == other.access_modes &&
    allocated_resources == other.allocated_resources &&
    capacity == other.capacity &&
    conditions == other.conditions &&
    phase == other.phase &&
    resize_status == other.resize_status
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



187
188
189
190
191
192
193
194
195
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
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 187

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 258

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 160

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


140
141
142
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



146
147
148
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 146

def hash
  [access_modes, allocated_resources, capacity, conditions, phase, resize_status].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



114
115
116
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 114

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



234
235
236
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 234

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 240

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



228
229
230
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 228

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



120
121
122
 
# File 'lib/zilla/models/io_k8s_api_core_v1_persistent_volume_claim_status.rb', line 120

def valid?
  true
end