Class: OCI::Core::Models::RouteRule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/route_rule.rb

Overview

A mapping between a destination IP address range and a virtual device to route matching packets to (a target).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RouteRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :cidr_block (String) —

    The value to assign to the #cidr_block property

  • :network_entity_id (String) —

    The value to assign to the #network_entity_id property



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/core/models/route_rule.rb', line 54

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.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']
end

Instance Attribute Details

#cidr_block ⇒ String

[Required] A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target).

Example: 0.0.0.0/0

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/core/models/route_rule.rb', line 17

def cidr_block
  @cidr_block
end

#network_entity_id ⇒ String

[Required] The OCID for the route rule’s target. For information about the type of targets you can specify, see [Route Tables](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm).

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/core/models/route_rule.rb', line 24

def network_entity_id
  @network_entity_id
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/oci/core/models/route_rule.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'cidrBlock',
    'network_entity_id': :'networkEntityId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/core/models/route_rule.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'String',
    'network_entity_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



80
81
82
83
84
85
 
# File 'lib/oci/core/models/route_rule.rb', line 80

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    cidr_block == other.cidr_block &&
    network_entity_id == other.network_entity_id
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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/core/models/route_rule.rb', line 110

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

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


90
91
92
 
# File 'lib/oci/core/models/route_rule.rb', line 90

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



99
100
101
 
# File 'lib/oci/core/models/route_rule.rb', line 99

def hash
  [cidr_block, network_entity_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/core/models/route_rule.rb', line 142

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



136
137
138
 
# File 'lib/oci/core/models/route_rule.rb', line 136

def to_s
  to_hash.to_s
end