Class: Kubevirt::K8sIoApiCoreV1DownwardAPIVolumeFile

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb

Overview

DownwardAPIVolumeFile represents information to create the file containing the pod field

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ K8sIoApiCoreV1DownwardAPIVolumeFile

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
95
96
97
98
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 67

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::K8sIoApiCoreV1DownwardAPIVolumeFile` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Kubevirt::K8sIoApiCoreV1DownwardAPIVolumeFile`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'path')
    self.path = attributes[:'path']
  else
    self.path = ''
  end

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

Instance Attribute Details

#field_ref ⇒ Object

Returns the value of attribute field_ref.



19
20
21
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 19

def field_ref
  @field_ref
end

#mode ⇒ Object

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.



22
23
24
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 22

def mode
  @mode
end

#path ⇒ Object

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the ‘..’ path. Must be utf-8 encoded. The first item of the relative path must not start with ‘..’



25
26
27
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 25

def path
  @path
end

#resource_field_ref ⇒ Object

Returns the value of attribute resource_field_ref.



27
28
29
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 27

def resource_field_ref
  @resource_field_ref
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



40
41
42
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 40

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 45

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 30

def self.attribute_map
  {
    :'field_ref' => :'fieldRef',
    :'mode' => :'mode',
    :'path' => :'path',
    :'resource_field_ref' => :'resourceFieldRef'
  }
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 156

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
63
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 60

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 50

def self.openapi_types
  {
    :'field_ref' => :'K8sIoApiCoreV1ObjectFieldSelector',
    :'mode' => :'Integer',
    :'path' => :'String',
    :'resource_field_ref' => :'K8sIoApiCoreV1ResourceFieldSelector'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field_ref == o.field_ref &&
      mode == o.mode &&
      path == o.path &&
      resource_field_ref == o.resource_field_ref
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



149
150
151
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 149

def hash
  [field_ref, mode, path, resource_field_ref].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



102
103
104
105
106
107
108
109
110
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 102

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @path.nil?
    invalid_properties.push('invalid value for "path", path cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 178

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



114
115
116
117
118
 
# File 'lib/kubevirt/models/k8s_io_api_core_v1_downward_api_volume_file.rb', line 114

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @path.nil?
  true
end