Class: Zilla::IoK8sApiCoreV1StorageOSPersistentVolumeSource

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_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 = {}) ⇒ IoK8sApiCoreV1StorageOSPersistentVolumeSource

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
89
90
91
92
93
94
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 67

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

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

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

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

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

  return unless attributes.key?(:volume_namespace)

  self.volume_namespace = attributes[:volume_namespace]
end

Instance Attribute Details

#fs_typeObject

fsType is the 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.



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

def fs_type
  @fs_type
end

#read_onlyObject

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



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

def read_only
  @read_only
end

#secret_refObject

Returns the value of attribute secret_ref.



25
26
27
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 25

def secret_ref
  @secret_ref
end

#volume_nameObject

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



28
29
30
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 28

def volume_name
  @volume_name
end

#volume_namespaceObject

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/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 31

def volume_namespace
  @volume_namespace
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



45
46
47
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



34
35
36
37
38
39
40
41
42
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_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

.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



136
137
138
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 136

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

.openapi_nullableObject

List of attributes with nullable: true



61
62
63
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 61

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

.openapi_typesObject

Attribute type mapping.



50
51
52
53
54
55
56
57
58
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 50

def self.openapi_types
  {
    fs_type: :String,
    read_only: :Boolean,
    secret_ref: :IoK8sApiCoreV1ObjectReference,
    volume_name: :String,
    volume_namespace: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



110
111
112
113
114
115
116
117
118
119
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 110

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



170
171
172
173
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
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 170

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



241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 143

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


123
124
125
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 123

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



129
130
131
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 129

def hash
  [fs_type, read_only, secret_ref, volume_name, volume_namespace].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



98
99
100
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 98

def list_invalid_properties
  []
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



217
218
219
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 217

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 223

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



211
212
213
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 211

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



104
105
106
# File 'lib/zilla/models/io_k8s_api_core_v1_storage_os_persistent_volume_source.rb', line 104

def valid?
  true
end