class OCI::LoadBalancer::Models::UpdateHealthCheckerDetails

The health checker's configuration details.

Attributes

interval_in_millis[RW]

[Required] The interval between health checks, in milliseconds.

Example: `10000`

@return [Integer]

port[RW]

[Required] The backend server port against which to run the health check.

Example: `8080`

@return [Integer]

protocol[RW]

[Required] The protocol the health check must use; either HTTP or TCP.

Example: `HTTP`

@return [String]

response_body_regex[RW]

[Required] A regular expression for parsing the response body from the backend server.

Example: `^((?!false).|\s)*$`

@return [String]

retries[RW]

[Required] The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state.

Example: `3`

@return [Integer]

return_code[RW]

[Required] The status code a healthy backend server should return.

Example: `200`

@return [Integer]

timeout_in_millis[RW]

[Required] The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period.

Example: `3000`

@return [Integer]

url_path[RW]

The path against which to run the health check.

Example: `/healthcheck`

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 69
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'protocol',
    'url_path': :'urlPath',
    'port': :'port',
    'return_code': :'returnCode',
    'retries': :'retries',
    'timeout_in_millis': :'timeoutInMillis',
    'interval_in_millis': :'intervalInMillis',
    'response_body_regex': :'responseBodyRegex'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :protocol The value to assign to the {#protocol} property @option attributes [String] :url_path The value to assign to the {#url_path} property @option attributes [Integer] :port The value to assign to the {#port} property @option attributes [Integer] :return_code The value to assign to the {#return_code} property @option attributes [Integer] :retries The value to assign to the {#retries} property @option attributes [Integer] :timeout_in_millis The value to assign to the {#timeout_in_millis} property @option attributes [Integer] :interval_in_millis The value to assign to the {#interval_in_millis} property @option attributes [String] :response_body_regex The value to assign to the {#response_body_regex} property

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 114
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.protocol = attributes[:'protocol'] if attributes[:'protocol']

  self.url_path = attributes[:'urlPath'] if attributes[:'urlPath']

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

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

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

  self.return_code = attributes[:'returnCode'] if attributes[:'returnCode']

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

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

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

  self.timeout_in_millis = attributes[:'timeoutInMillis'] if attributes[:'timeoutInMillis']

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

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

  self.interval_in_millis = attributes[:'intervalInMillis'] if attributes[:'intervalInMillis']

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

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

  self.response_body_regex = attributes[:'responseBodyRegex'] if attributes[:'responseBodyRegex']

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

  self.response_body_regex = attributes[:'response_body_regex'] if attributes[:'response_body_regex']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 85
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'String',
    'url_path': :'String',
    'port': :'Integer',
    'return_code': :'Integer',
    'retries': :'Integer',
    'timeout_in_millis': :'Integer',
    'interval_in_millis': :'Integer',
    'response_body_regex': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 164
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    protocol == other.protocol &&
    url_path == other.url_path &&
    port == other.port &&
    return_code == other.return_code &&
    retries == other.retries &&
    timeout_in_millis == other.timeout_in_millis &&
    interval_in_millis == other.interval_in_millis &&
    response_body_regex == other.response_body_regex
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 201
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 181
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 190
def hash
  [protocol, url_path, port, return_code, retries, timeout_in_millis, interval_in_millis, response_body_regex].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 234
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 228
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/load_balancer/models/update_health_checker_details.rb, line 251
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end