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).

Constant Summary collapse

DESTINATION_TYPE_ENUM = 
[
  DESTINATION_TYPE_CIDR_BLOCK = 'CIDR_BLOCK'.freeze,
  DESTINATION_TYPE_SERVICE_CIDR_BLOCK = 'SERVICE_CIDR_BLOCK'.freeze,
  DESTINATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ROUTE_TYPE_ENUM = 
[
  ROUTE_TYPE_STATIC = 'STATIC'.freeze,
  ROUTE_TYPE_LOCAL = 'LOCAL'.freeze,
  ROUTE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

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

  • :destination (String) —

    The value to assign to the #destination property

  • :destination_type (String) —

    The value to assign to the #destination_type property

  • :network_entity_id (String) —

    The value to assign to the #network_entity_id property

  • :description (String) —

    The value to assign to the #description property

  • :route_type (String) —

    The value to assign to the #route_type property



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/core/models/route_rule.rb', line 125

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

  self.route_type = attributes[:'routeType'] if attributes[:'routeType']

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

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

Instance Attribute Details

#cidr_block ⇒ String

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 prefix.

Example: 0.0.0.0/0

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/core/models/route_rule.rb', line 37

def cidr_block
  @cidr_block
end

#description ⇒ String

An optional description of your choice for the rule.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/core/models/route_rule.rb', line 78

def description
  @description
end

#destination ⇒ 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 CIDR block or IPv6 prefix. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56. If you set this to an IPv6 prefix, 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.

  • 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.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/core/models/route_rule.rb', line 55

def destination
  @destination
end

#destination_type ⇒ 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).

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/core/models/route_rule.rb', line 66

def destination_type
  @destination_type
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.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/core/models/route_rule.rb', line 73

def network_entity_id
  @network_entity_id
end

#route_type ⇒ String

A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table.

Returns:

  • (String) 


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

def route_type
  @route_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'cidrBlock',
    'destination': :'destination',
    'destination_type': :'destinationType',
    'network_entity_id': :'networkEntityId',
    'description': :'description',
    'route_type': :'routeType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/core/models/route_rule.rb', line 100

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'String',
    'destination': :'String',
    'destination_type': :'String',
    'network_entity_id': :'String',
    'description': :'String',
    'route_type': :'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



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/core/models/route_rule.rb', line 195

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 &&
    route_type == other.route_type
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/core/models/route_rule.rb', line 230

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


210
211
212
 
# File 'lib/oci/core/models/route_rule.rb', line 210

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/oci/core/models/route_rule.rb', line 219

def hash
  [cidr_block, destination, destination_type, network_entity_id, description, route_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/core/models/route_rule.rb', line 263

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



257
258
259
 
# File 'lib/oci/core/models/route_rule.rb', line 257

def to_s
  to_hash.to_s
end