class OCI::Core::Models::RouteRule
A mapping between a destination IP address range and a virtual device to route matching packets to (a target).
Constants
- DESTINATION_TYPE_ENUM
Attributes
Deprecated. Instead use `destination` and `destinationType`. Requests that include both `cidrBlock` and `destination` will be rejected.
A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target).
Cannot be an IPv6 CIDR.
Example: `0.0.0.0/0`
@return [String]
An optional description of your choice for the rule.
@return [String]
Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a `destinationType`.
Allowed values:
* IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If you set this to an IPv6 CIDR, the route rule's target can only be a DRG or internet gateway. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm). * The `cidrBlock` value for a {Service}, if you're setting up a route rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
@return [String]
Type of destination for the rule. Required if you provide a `destination`.
* `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a {Service} (the rule is for traffic destined for a particular `Service` through a service gateway).
@return [String]
[Required] The OCID for the route rule's target. For information about the type of targets you can specify, see [Route Tables](docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/route_rule.rb, line 74 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'cidrBlock', 'destination': :'destination', 'destination_type': :'destinationType', 'network_entity_id': :'networkEntityId', 'description': :'description' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :cidr_block The value to assign to the {#cidr_block} property @option attributes [String] :destination The value to assign to the {#destination} property @option attributes [String] :destination_type The value to assign to the {#destination_type} property @option attributes [String] :network_entity_id The value to assign to the {#network_entity_id} property @option attributes [String] :description The value to assign to the {#description} property
# File lib/oci/core/models/route_rule.rb, line 110 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.cidr_block = attributes[:'cidrBlock'] if attributes[:'cidrBlock'] raise 'You cannot provide both :cidrBlock and :cidr_block' if attributes.key?(:'cidrBlock') && attributes.key?(:'cidr_block') self.cidr_block = attributes[:'cidr_block'] if attributes[:'cidr_block'] self.destination = attributes[:'destination'] if attributes[:'destination'] self.destination_type = attributes[:'destinationType'] if attributes[:'destinationType'] self.destination_type = "CIDR_BLOCK" if destination_type.nil? && !attributes.key?(:'destinationType') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :destinationType and :destination_type' if attributes.key?(:'destinationType') && attributes.key?(:'destination_type') self.destination_type = attributes[:'destination_type'] if attributes[:'destination_type'] self.destination_type = "CIDR_BLOCK" if destination_type.nil? && !attributes.key?(:'destinationType') && !attributes.key?(:'destination_type') # rubocop:disable Style/StringLiterals self.network_entity_id = attributes[:'networkEntityId'] if attributes[:'networkEntityId'] raise 'You cannot provide both :networkEntityId and :network_entity_id' if attributes.key?(:'networkEntityId') && attributes.key?(:'network_entity_id') self.network_entity_id = attributes[:'network_entity_id'] if attributes[:'network_entity_id'] self.description = attributes[:'description'] if attributes[:'description'] end
Attribute type mapping.
# File lib/oci/core/models/route_rule.rb, line 87 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'String', 'destination': :'String', 'destination_type': :'String', 'network_entity_id': :'String', 'description': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/route_rule.rb, line 161 def ==(other) return true if equal?(other) self.class == other.class && cidr_block == other.cidr_block && destination == other.destination && destination_type == other.destination_type && network_entity_id == other.network_entity_id && description == other.description end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/route_rule.rb, line 195 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/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) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method checking allowed values (enum). @param [Object] destination_type
Object
to be assigned
# File lib/oci/core/models/route_rule.rb, line 145 def destination_type=(destination_type) # rubocop:disable Style/ConditionalAssignment if destination_type && !DESTINATION_TYPE_ENUM.include?(destination_type) OCI.logger.debug("Unknown value for 'destination_type' [" + destination_type + "]. Mapping to 'DESTINATION_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @destination_type = DESTINATION_TYPE_UNKNOWN_ENUM_VALUE else @destination_type = destination_type end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/route_rule.rb, line 175 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/route_rule.rb, line 184 def hash [cidr_block, destination, destination_type, network_entity_id, description].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/route_rule.rb, line 228 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/route_rule.rb, line 222 def to_s to_hash.to_s end
Private Instance Methods
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/oci/core/models/route_rule.rb, line 245 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