class IbmCloudPower::Network
Attributes
Network
in CIDR notation (192.168.0.0/24)
DNS Servers
Gateway IP Address
IP Address Ranges
MTU Jumbo Network
enabled
Network
Name
Unique Network
ID
Public IP Address Ranges (for pub-vlan networks)
Type of Network
{vlan, pub-vlan}
VLAN ID
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ibm_cloud_power/models/network.rb, line 72 def self.attribute_map { :'network_id' => :'networkID', :'name' => :'name', :'type' => :'type', :'vlan_id' => :'vlanID', :'cidr' => :'cidr', :'gateway' => :'gateway', :'dns_servers' => :'dnsServers', :'ip_address_ranges' => :'ipAddressRanges', :'ip_address_metrics' => :'ipAddressMetrics', :'public_ip_address_ranges' => :'publicIPAddressRanges', :'jumbo' => :'jumbo' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ibm_cloud_power/models/network.rb, line 282 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ibm_cloud_power/models/network.rb, line 113 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::Network` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `IbmCloudPower::Network`. 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 } if attributes.key?(:'network_id') self.network_id = attributes[:'network_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'type') self.type = attributes[:'type'] else self.type = 'vlan' end if attributes.key?(:'vlan_id') self.vlan_id = attributes[:'vlan_id'] end if attributes.key?(:'cidr') self.cidr = attributes[:'cidr'] end if attributes.key?(:'gateway') self.gateway = attributes[:'gateway'] end if attributes.key?(:'dns_servers') if (value = attributes[:'dns_servers']).is_a?(Array) self.dns_servers = value end end if attributes.key?(:'ip_address_ranges') if (value = attributes[:'ip_address_ranges']).is_a?(Array) self.ip_address_ranges = value end end if attributes.key?(:'ip_address_metrics') self.ip_address_metrics = attributes[:'ip_address_metrics'] end if attributes.key?(:'public_ip_address_ranges') if (value = attributes[:'public_ip_address_ranges']).is_a?(Array) self.public_ip_address_ranges = value end end if attributes.key?(:'jumbo') self.jumbo = attributes[:'jumbo'] end end
List of attributes with nullable: true
# File lib/ibm_cloud_power/models/network.rb, line 106 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ibm_cloud_power/models/network.rb, line 89 def self.openapi_types { :'network_id' => :'String', :'name' => :'String', :'type' => :'String', :'vlan_id' => :'Float', :'cidr' => :'String', :'gateway' => :'String', :'dns_servers' => :'Array<String>', :'ip_address_ranges' => :'Array<IPAddressRange>', :'ip_address_metrics' => :'NetworkIpAddressMetrics', :'public_ip_address_ranges' => :'Array<IPAddressRange>', :'jumbo' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ibm_cloud_power/models/network.rb, line 251 def ==(o) return true if self.equal?(o) self.class == o.class && network_id == o.network_id && name == o.name && type == o.type && vlan_id == o.vlan_id && cidr == o.cidr && gateway == o.gateway && dns_servers == o.dns_servers && ip_address_ranges == o.ip_address_ranges && ip_address_metrics == o.ip_address_metrics && public_ip_address_ranges == o.public_ip_address_ranges && jumbo == o.jumbo end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ibm_cloud_power/models/network.rb, line 312 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 IbmCloudPower.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/ibm_cloud_power/models/network.rb, line 381 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ibm_cloud_power/models/network.rb, line 289 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/ibm_cloud_power/models/network.rb, line 269 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ibm_cloud_power/models/network.rb, line 275 def hash [network_id, name, type, vlan_id, cidr, gateway, dns_servers, ip_address_ranges, ip_address_metrics, public_ip_address_ranges, jumbo].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ibm_cloud_power/models/network.rb, line 181 def list_invalid_properties invalid_properties = Array.new if @network_id.nil? invalid_properties.push('invalid value for "network_id", network_id cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @vlan_id.nil? invalid_properties.push('invalid value for "vlan_id", vlan_id cannot be nil.') end if @cidr.nil? invalid_properties.push('invalid value for "cidr", cidr cannot be nil.') end if @dns_servers.nil? invalid_properties.push('invalid value for "dns_servers", dns_servers cannot be nil.') end if @ip_address_ranges.nil? invalid_properties.push('invalid value for "ip_address_ranges", ip_address_ranges cannot be nil.') end if @ip_address_metrics.nil? invalid_properties.push('invalid value for "ip_address_metrics", ip_address_metrics cannot be nil.') end if @jumbo.nil? invalid_properties.push('invalid value for "jumbo", jumbo cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ibm_cloud_power/models/network.rb, line 363 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ibm_cloud_power/models/network.rb, line 351 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/ibm_cloud_power/models/network.rb, line 241 def type=(type) validator = EnumAttributeValidator.new('String', ["pub-vlan", "vlan", "vxlan"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ibm_cloud_power/models/network.rb, line 224 def valid? return false if @network_id.nil? return false if @name.nil? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["pub-vlan", "vlan", "vxlan"]) return false unless type_validator.valid?(@type) return false if @vlan_id.nil? return false if @cidr.nil? return false if @dns_servers.nil? return false if @ip_address_ranges.nil? return false if @ip_address_metrics.nil? return false if @jumbo.nil? true end