Class: OCI::LoadBalancer::Models::ConnectionConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/load_balancer/models/connection_configuration.rb

Overview

Configuration details for the connection between the client and backend servers.

Constant Summary collapse

BACKEND_TCP_PROXY_PROTOCOL_OPTIONS_ENUM = 
[
  BACKEND_TCP_PROXY_PROTOCOL_OPTIONS_PP2_TYPE_AUTHORITY = 'PP2_TYPE_AUTHORITY'.freeze,
  BACKEND_TCP_PROXY_PROTOCOL_OPTIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectionConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 73

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

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

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

  self.backend_tcp_proxy_protocol_version = attributes[:'backendTcpProxyProtocolVersion'] if attributes[:'backendTcpProxyProtocolVersion']

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

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

  self.backend_tcp_proxy_protocol_options = attributes[:'backendTcpProxyProtocolOptions'] if attributes[:'backendTcpProxyProtocolOptions']

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

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

Instance Attribute Details

#backend_tcp_proxy_protocol_options ⇒ Array<String>

An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: ["PP2_TYPE_AUTHORITY"]

Returns:

  • (Array<String>) 


40
41
42
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 40

def backend_tcp_proxy_protocol_options
  @backend_tcp_proxy_protocol_options
end

#backend_tcp_proxy_protocol_version ⇒ Integer

The backend TCP Proxy Protocol version.

Example: 1

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 34

def backend_tcp_proxy_protocol_version
  @backend_tcp_proxy_protocol_version
end

#idle_timeout ⇒ Integer

[Required] The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations.

For more information, see Connection Configuration.

Example: 1200

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 27

def idle_timeout
  @idle_timeout
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'idle_timeout': :'idleTimeout',
    'backend_tcp_proxy_protocol_version': :'backendTcpProxyProtocolVersion',
    'backend_tcp_proxy_protocol_options': :'backendTcpProxyProtocolOptions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'idle_timeout': :'Integer',
    'backend_tcp_proxy_protocol_version': :'Integer',
    'backend_tcp_proxy_protocol_options': :'Array<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



125
126
127
128
129
130
131
132
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 125

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

  self.class == other.class &&
    idle_timeout == other.idle_timeout &&
    backend_tcp_proxy_protocol_version == other.backend_tcp_proxy_protocol_version &&
    backend_tcp_proxy_protocol_options == other.backend_tcp_proxy_protocol_options
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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 157

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


137
138
139
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 146

def hash
  [idle_timeout, backend_tcp_proxy_protocol_version, backend_tcp_proxy_protocol_options].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 190

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



184
185
186
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 184

def to_s
  to_hash.to_s
end