Class: OCI::VnMonitoring::Models::CreateFlexTunnelConfigurationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb

Overview

The create details for tunnel configuration. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

CreateGreFlexTunnelConfigurationDetails

Constant Summary collapse

TUNNEL_TYPE_ENUM =
[
  TUNNEL_TYPE_GRE = 'GRE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFlexTunnelConfigurationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 81

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.tunnel_type = attributes[:'tunnelType'] if attributes[:'tunnelType']

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

  self.tunnel_type = attributes[:'tunnel_type'] if attributes[:'tunnel_type']

  self.customer_tunnel_ip = attributes[:'customerTunnelIp'] if attributes[:'customerTunnelIp']

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

  self.customer_tunnel_ip = attributes[:'customer_tunnel_ip'] if attributes[:'customer_tunnel_ip']

  self.oracle_tunnel_ip = attributes[:'oracleTunnelIp'] if attributes[:'oracleTunnelIp']

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

  self.oracle_tunnel_ip = attributes[:'oracle_tunnel_ip'] if attributes[:'oracle_tunnel_ip']

  self.bgp_session = attributes[:'bgpSession'] if attributes[:'bgpSession']

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

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

Instance Attribute Details

#bgp_sessionOCI::VnMonitoring::Models::CreateFlexTunnelBgpSessionDetails

This attribute is required.



30
31
32
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 30

def bgp_session
  @bgp_session
end

#customer_tunnel_ipString

[Required] IP address of your end of the tunnel.

Returns:

  • (String)


22
23
24
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 22

def customer_tunnel_ip
  @customer_tunnel_ip
end

#oracle_tunnel_ipString

[Required] IP address of the oracle end of the tunnel.

Returns:

  • (String)


26
27
28
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 26

def oracle_tunnel_ip
  @oracle_tunnel_ip
end

#tunnel_typeString

[Required] The tunnel encapsulation protocol.

Returns:

  • (String)


18
19
20
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 18

def tunnel_type
  @tunnel_type
end

Class Method Details

.attribute_mapObject

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



33
34
35
36
37
38
39
40
41
42
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'tunnel_type': :'tunnelType',
    'customer_tunnel_ip': :'customerTunnelIp',
    'oracle_tunnel_ip': :'oracleTunnelIp',
    'bgp_session': :'bgpSession'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



61
62
63
64
65
66
67
68
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 61

def self.get_subtype(object_hash)
  type = object_hash[:'tunnelType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::VnMonitoring::Models::CreateGreFlexTunnelConfigurationDetails' if type == 'GRE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::VnMonitoring::Models::CreateFlexTunnelConfigurationDetails'
end

.swagger_typesObject

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'tunnel_type': :'String',
    'customer_tunnel_ip': :'String',
    'oracle_tunnel_ip': :'String',
    'bgp_session': :'OCI::VnMonitoring::Models::CreateFlexTunnelBgpSessionDetails'
    # 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



127
128
129
130
131
132
133
134
135
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 127

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    tunnel_type == other.tunnel_type &&
    customer_tunnel_ip == other.customer_tunnel_ip &&
    oracle_tunnel_ip == other.oracle_tunnel_ip &&
    bgp_session == other.bgp_session
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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 160

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


140
141
142
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 140

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



149
150
151
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 149

def hash
  [tunnel_type, customer_tunnel_ip, oracle_tunnel_ip, bgp_session].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 193

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



187
188
189
# File 'lib/oci/vn_monitoring/models/create_flex_tunnel_configuration_details.rb', line 187

def to_s
  to_hash.to_s
end