Class: Kubernetes::V1StorageOSVolumeSource

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

Overview

Represents a StorageOS persistent volume resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1StorageOSVolumeSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 57

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.read_only = attributes[:readOnly] if attributes.key?(:readOnly)

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

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

  return unless attributes.key?(:volumeNamespace)

  self.volume_namespace = attributes[:volumeNamespace]
end

Instance Attribute Details

#fs_type ⇒ Object

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



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

def fs_type
  @fs_type
end

#read_only ⇒ Object

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.



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

def read_only
  @read_only
end

#secret_ref ⇒ Object

SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.



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

def secret_ref
  @secret_ref
end

#volume_name ⇒ Object

VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.



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

def volume_name
  @volume_name
end

#volume_namespace ⇒ Object

VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.



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

def volume_namespace
  @volume_namespace
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 34

def self.attribute_map
  {
    fs_type: :fsType,
    read_only: :readOnly,
    secret_ref: :secretRef,
    volume_name: :volumeName,
    volume_namespace: :volumeNamespace
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    fs_type: :String,
    read_only: :BOOLEAN,
    secret_ref: :V1LocalObjectReference,
    volume_name: :String,
    volume_namespace: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 90

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

  self.class == other.class &&
    fs_type == other.fs_type &&
    read_only == other.read_only &&
    secret_ref == other.secret_ref &&
    volume_name == other.volume_name &&
    volume_namespace == other.volume_namespace
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 140

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



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

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 116

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


103
104
105
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 103

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 109

def hash
  [fs_type, read_only, secret_ref, volume_name, volume_namespace].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



78
79
80
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 78

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



186
187
188
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 186

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



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 192

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



180
181
182
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 180

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



84
85
86
 
# File 'lib/kubernetes/models/v1_storage_os_volume_source.rb', line 84

def valid?
  true
end