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.

Instance Attribute 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):

  • :idle_timeout (Integer) —

    The value to assign to the #idle_timeout property



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 51

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

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

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

end

Instance Attribute Details

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

The default values are:

  • 300 seconds for TCP

  • 60 seconds for HTTP and WebSocket protocols.

Note: The protocol is set at the listener.

Modify this parameter if the client or backend server stops transmitting data for more than the default time. Some examples include:

  • The client sends a database query to the backend server and the database takes over 300 seconds to execute. Therefore, the backend server does not transmit any data within 300 seconds.

  • The client uploads data using the HTTP protocol. During the upload, the backend does not transmit any data to the client for more than 60 seconds.

  • The client downloads data using the HTTP protocol. After the initial request, it stops transmitting data to the backend server for more than 60 seconds.

  • The client starts transmitting data after establishing a WebSocket connection, but the backend server does not transmit data for more than 60 seconds.

  • The backend server starts transmitting data after establishing a WebSocket connection, but the client does not transmit data for more than 60 seconds.

The maximum value is 7200 seconds. Contact My Oracle Support to file a service request if you want to increase this limit for your tenancy. For more information, see [Service Limits](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm).

Example: ‘1200`

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 45

def idle_timeout
  @idle_timeout
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



71
72
73
74
75
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 71

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 92

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


79
80
81
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 79

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



85
86
87
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 85

def hash
  [idle_timeout].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 117

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



111
112
113
 
# File 'lib/oci/load_balancer/models/connection_configuration.rb', line 111

def to_s
  to_hash.to_s
end