Class: OCI::Core::Models::DpdConfig

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

Overview

These configuration details are used for dead peer detection (DPD). DPD periodically checks the stability of the connection to the customer premises (CPE), and may be used to detect that the link to the CPE has gone down.

Constant Summary collapse

DPD_MODE_ENUM = 
[
  DPD_MODE_INITIATE_AND_RESPOND = 'INITIATE_AND_RESPOND'.freeze,
  DPD_MODE_RESPOND_ONLY = 'RESPOND_ONLY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DpdConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :dpd_mode (String) —

    The value to assign to the #dpd_mode property

  • :dpd_timeout_in_sec (Integer) —

    The value to assign to the #dpd_timeout_in_sec property



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

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

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

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

  self.dpd_timeout_in_sec = attributes[:'dpdTimeoutInSec'] if attributes[:'dpdTimeoutInSec']

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

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

Instance Attribute Details

#dpd_mode ⇒ String

This option defines whether DPD can be initiated from the Oracle side of the connection.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/core/models/dpd_config.rb', line 20

def dpd_mode
  @dpd_mode
end

#dpd_timeout_in_sec ⇒ Integer

DPD timeout in seconds. This sets the longest interval between CPE device health messages before the IPSec connection indicates it has lost contact with the CPE. The default is 20 seconds.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/core/models/dpd_config.rb', line 25

def dpd_timeout_in_sec
  @dpd_timeout_in_sec
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dpd_mode': :'dpdMode',
    'dpd_timeout_in_sec': :'dpdTimeoutInSec'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'dpd_mode': :'String',
    'dpd_timeout_in_sec': :'Integer'
    # 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



89
90
91
92
93
94
95
 
# File 'lib/oci/core/models/dpd_config.rb', line 89

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

  self.class == other.class &&
    dpd_mode == other.dpd_mode &&
    dpd_timeout_in_sec == other.dpd_timeout_in_sec
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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/core/models/dpd_config.rb', line 120

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


100
101
102
 
# File 'lib/oci/core/models/dpd_config.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/core/models/dpd_config.rb', line 109

def hash
  [dpd_mode, dpd_timeout_in_sec].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/core/models/dpd_config.rb', line 153

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



147
148
149
 
# File 'lib/oci/core/models/dpd_config.rb', line 147

def to_s
  to_hash.to_s
end