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

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/core/models/route_rule.rb', line 30

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}

  if attributes[:'cidrBlock']
    self.cidr_block = attributes[:'cidrBlock']
  end

  raise 'You cannot provide both :cidrBlock and :cidr_block' if attributes.key?(:'cidrBlock') && attributes.key?(:'cidr_block')

  if attributes[:'cidr_block']
    self.cidr_block = attributes[:'cidr_block']
  end

  if attributes[:'networkEntityId']
    self.network_entity_id = attributes[:'networkEntityId']
  end

  raise 'You cannot provide both :networkEntityId and :network_entity_id' if attributes.key?(:'networkEntityId') && attributes.key?(:'network_entity_id')

  if attributes[:'network_entity_id']
    self.network_entity_id = attributes[:'network_entity_id']
  end

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) 


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

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) 


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

def network_entity_id
  @network_entity_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



60
61
62
63
64
65
 
# File 'lib/oci/core/models/route_rule.rb', line 60

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/core/models/route_rule.rb', line 82

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


69
70
71
 
# File 'lib/oci/core/models/route_rule.rb', line 69

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



75
76
77
 
# File 'lib/oci/core/models/route_rule.rb', line 75

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



107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/core/models/route_rule.rb', line 107

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



101
102
103
 
# File 'lib/oci/core/models/route_rule.rb', line 101

def to_s
  to_hash.to_s
end