Class: Kubevirt::V1DHCPOptions

Inherits:
ApiModelBase show all
Defined in:
lib/kubevirt/models/v1_dhcp_options.rb

Overview

Extra DHCP options to use in the interface.

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 = {}) ⇒ V1DHCPOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
99
100
101
102
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kubevirt::V1DHCPOptions` 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::V1DHCPOptions`. 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?(:'boot_file_name')
    self.boot_file_name = attributes[:'boot_file_name']
  end

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

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

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

Instance Attribute Details

#boot_file_name ⇒ Object

If specified will pass option 67 to interface’s DHCP server



20
21
22
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 20

def boot_file_name
  @boot_file_name
end

#ntp_servers ⇒ Object

If specified will pass the configured NTP server to the VM via DHCP option 042.



23
24
25
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 23

def ntp_servers
  @ntp_servers
end

#private_options ⇒ Object

If specified will pass extra DHCP options for private use, range: 224-254



26
27
28
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 26

def private_options
  @private_options
end

#tftp_server_name ⇒ Object

If specified will pass option 66 to interface’s DHCP server



29
30
31
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 29

def tftp_server_name
  @tftp_server_name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 32

def self.attribute_map
  {
    :'boot_file_name' => :'bootFileName',
    :'ntp_servers' => :'ntpServers',
    :'private_options' => :'privateOptions',
    :'tftp_server_name' => :'tftpServerName'
  }
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



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

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



62
63
64
65
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 52

def self.openapi_types
  {
    :'boot_file_name' => :'String',
    :'ntp_servers' => :'Array<String>',
    :'private_options' => :'Array<V1DHCPPrivateOptions>',
    :'tftp_server_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      boot_file_name == o.boot_file_name &&
      ntp_servers == o.ntp_servers &&
      private_options == o.private_options &&
      tftp_server_name == o.tftp_server_name
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


132
133
134
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 132

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



138
139
140
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 138

def hash
  [boot_file_name, ntp_servers, private_options, tftp_server_name].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



106
107
108
109
110
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 106

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 167

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
 
# File 'lib/kubevirt/models/v1_dhcp_options.rb', line 114

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end