Class: Kubernetes::V1CSIPersistentVolumeSource

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

Overview

Represents storage that is managed by an external CSI volume driver (Beta feature)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1CSIPersistentVolumeSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:controllerPublishSecretRef)
    self.controller_publish_secret_ref = attributes[:controllerPublishSecretRef]
  end

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

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

  if attributes.key?(:nodePublishSecretRef)
    self.node_publish_secret_ref = attributes[:nodePublishSecretRef]
  end

  if attributes.key?(:nodeStageSecretRef)
    self.node_stage_secret_ref = attributes[:nodeStageSecretRef]
  end

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

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

  return unless attributes.key?(:volumeHandle)

  self.volume_handle = attributes[:volumeHandle]
end

Instance Attribute Details

#controller_publish_secret_ref ⇒ Object

ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.



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

def controller_publish_secret_ref
  @controller_publish_secret_ref
end

#driver ⇒ Object

Driver is the name of the driver to use for this volume. Required.



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

def driver
  @driver
end

#fs_type ⇒ Object

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".



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

def fs_type
  @fs_type
end

#node_publish_secret_ref ⇒ Object

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.



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

def node_publish_secret_ref
  @node_publish_secret_ref
end

#node_stage_secret_ref ⇒ Object

NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.



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

def node_stage_secret_ref
  @node_stage_secret_ref
end

#read_only ⇒ Object

Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).



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

def read_only
  @read_only
end

#volume_attributes ⇒ Object

Attributes of the volume to publish.



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

def volume_attributes
  @volume_attributes
end

#volume_handle ⇒ Object

VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.



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

def volume_handle
  @volume_handle
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    controller_publish_secret_ref: :controllerPublishSecretRef,
    driver: :driver,
    fs_type: :fsType,
    node_publish_secret_ref: :nodePublishSecretRef,
    node_stage_secret_ref: :nodeStageSecretRef,
    read_only: :readOnly,
    volume_attributes: :volumeAttributes,
    volume_handle: :volumeHandle
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 57

def self.swagger_types
  {
    controller_publish_secret_ref: :V1SecretReference,
    driver: :String,
    fs_type: :String,
    node_publish_secret_ref: :V1SecretReference,
    node_stage_secret_ref: :V1SecretReference,
    read_only: :BOOLEAN,
    volume_attributes: :'Hash<String, String>',
    volume_handle: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 129

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

  self.class == other.class &&
    controller_publish_secret_ref == other.controller_publish_secret_ref &&
    driver == other.driver &&
    fs_type == other.fs_type &&
    node_publish_secret_ref == other.node_publish_secret_ref &&
    node_stage_secret_ref == other.node_stage_secret_ref &&
    read_only == other.read_only &&
    volume_attributes == other.volume_attributes &&
    volume_handle == other.volume_handle
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



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
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 183

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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 250

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 159

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


145
146
147
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
154
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 151

def hash
  [controller_publish_secret_ref, driver, fs_type, node_publish_secret_ref,
   node_stage_secret_ref, read_only, volume_attributes, volume_handle].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



107
108
109
110
111
112
113
114
115
116
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 107

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

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

  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



229
230
231
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 229

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



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 235

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



223
224
225
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 223

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
123
124
125
 
# File 'lib/kubernetes/models/v1_csi_persistent_volume_source.rb', line 120

def valid?
  return false if @driver.nil?
  return false if @volume_handle.nil?

  true
end