class OCI::NetworkLoadBalancer::Models::Listener

The congfiguration of the listener. For more information about backend set configuration, see [Managing Load Balancer Listeners](docs.cloud.oracle.com/Content/Balance/Tasks/managinglisteners.htm).

Constants

PROTOCOL_ENUM

Attributes

default_backend_set_name[RW]

[Required] The name of the associated backend set.

Example: `example_backend_set`

@return [String]

name[RW]

[Required] A friendly name for the listener. It must be unique and it cannot be changed.

Example: `example_listener`

@return [String]

port[RW]

[Required] The communication port for the listener.

Example: `80`

@return [Integer]

protocol[R]

[Required] The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). To get a list of valid protocols, use the {#list_network_load_balancers_protocols list_network_load_balancers_protocols} operation.

Example: `TCP`

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/network_load_balancer/models/listener.rb, line 54
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'default_backend_set_name': :'defaultBackendSetName',
    'port': :'port',
    'protocol': :'protocol'
    # 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] :name The value to assign to the {#name} property @option attributes [String] :default_backend_set_name The value to assign to the {#default_backend_set_name} property @option attributes [Integer] :port The value to assign to the {#port} property @option attributes [String] :protocol The value to assign to the {#protocol} property

# File lib/oci/network_load_balancer/models/listener.rb, line 87
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.name = attributes[:'name'] if attributes[:'name']

  self.default_backend_set_name = attributes[:'defaultBackendSetName'] if attributes[:'defaultBackendSetName']

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

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

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

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

Attribute type mapping.

# File lib/oci/network_load_balancer/models/listener.rb, line 66
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'default_backend_set_name': :'String',
    'port': :'Integer',
    'protocol': :'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/network_load_balancer/models/listener.rb, line 126
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    default_backend_set_name == other.default_backend_set_name &&
    port == other.port &&
    protocol == other.protocol
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/network_load_balancer/models/listener.rb, line 159
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/network_load_balancer/models/listener.rb, line 139
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/network_load_balancer/models/listener.rb, line 148
def hash
  [name, default_backend_set_name, port, protocol].hash
end
protocol=(protocol) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] protocol Object to be assigned

# File lib/oci/network_load_balancer/models/listener.rb, line 110
def protocol=(protocol)
  # rubocop:disable Style/ConditionalAssignment
  if protocol && !PROTOCOL_ENUM.include?(protocol)
    OCI.logger.debug("Unknown value for 'protocol' [" + protocol + "]. Mapping to 'PROTOCOL_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @protocol = PROTOCOL_UNKNOWN_ENUM_VALUE
  else
    @protocol = protocol
  end
  # rubocop:enable Style/ConditionalAssignment
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/network_load_balancer/models/listener.rb, line 192
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/network_load_balancer/models/listener.rb, line 186
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/network_load_balancer/models/listener.rb, line 209
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