Class: Kubernetes::V1RBDVolumeSource

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

Overview

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1RBDVolumeSource

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
 
# File 'lib/kubernetes/models/v1_rbd_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)

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

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

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

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

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

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

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

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

Instance Attribute Details

#fs_type ⇒ Object

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: kubernetes.io/docs/concepts/storage/volumes#rbd



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

def fs_type
  @fs_type
end

#image ⇒ Object

The rados image name. More info: releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it



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

def image
  @image
end

#keyring ⇒ Object

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it



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

def keyring
  @keyring
end

#monitors ⇒ Object

A collection of Ceph monitors. More info: releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it



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

def monitors
  @monitors
end

#pool ⇒ Object

The rados pool name. Default is rbd. More info: releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it



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

def pool
  @pool
end

#read_only ⇒ Object

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it



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

def read_only
  @read_only
end

#secret_ref ⇒ Object

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it



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

def secret_ref
  @secret_ref
end

#user ⇒ Object

The rados user name. Default is admin. More info: releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it



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

def user
  @user
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_rbd_volume_source.rb', line 43

def self.attribute_map
  {
    fs_type: :fsType,
    image: :image,
    keyring: :keyring,
    monitors: :monitors,
    pool: :pool,
    read_only: :readOnly,
    secret_ref: :secretRef,
    user: :user
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    fs_type: :String,
    image: :String,
    keyring: :String,
    monitors: :'Array<String>',
    pool: :String,
    read_only: :BOOLEAN,
    secret_ref: :V1LocalObjectReference,
    user: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 121

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

  self.class == other.class &&
    fs_type == other.fs_type &&
    image == other.image &&
    keyring == other.keyring &&
    monitors == other.monitors &&
    pool == other.pool &&
    read_only == other.read_only &&
    secret_ref == other.secret_ref &&
    user == other.user
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



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
209
210
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 174

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 241

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 150

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


137
138
139
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 143

def hash
  [fs_type, image, keyring, monitors, pool, read_only, secret_ref, user].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



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 99

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

  if @monitors.nil?
    invalid_properties.push("invalid value for 'monitors', monitors 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



220
221
222
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 220

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



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

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



214
215
216
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 214

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



112
113
114
115
116
117
 
# File 'lib/kubernetes/models/v1_rbd_volume_source.rb', line 112

def valid?
  return false if @image.nil?
  return false if @monitors.nil?

  true
end