Class: OCI::NetworkLoadBalancer::Models::ListenerSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/network_load_balancer/models/listener_summary.rb

Overview

The configuration of the listener. For more information about backend set configuration, see Managing Load Balancer Listeners.

Constant Summary collapse

PROTOCOL_ENUM = 
[
  PROTOCOL_ANY = 'ANY'.freeze,
  PROTOCOL_TCP = 'TCP'.freeze,
  PROTOCOL_UDP = 'UDP'.freeze,
  PROTOCOL_TCP_AND_UDP = 'TCP_AND_UDP'.freeze,
  PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IP_VERSION_ENUM = 
[
  IP_VERSION_IPV4 = 'IPV4'.freeze,
  IP_VERSION_IPV6 = 'IPV6'.freeze,
  IP_VERSION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListenerSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :default_backend_set_name (String) —

    The value to assign to the #default_backend_set_name property

  • :port (Integer) —

    The value to assign to the #port property

  • :protocol (String) —

    The value to assign to the #protocol property

  • :ip_version (String) —

    The value to assign to the #ip_version property



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 102

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']

  self.ip_version = attributes[:'ipVersion'] if attributes[:'ipVersion']
  self.ip_version = "IPV4" if ip_version.nil? && !attributes.key?(:'ipVersion') # rubocop:disable Style/StringLiterals

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

  self.ip_version = attributes[:'ip_version'] if attributes[:'ip_version']
  self.ip_version = "IPV4" if ip_version.nil? && !attributes.key?(:'ipVersion') && !attributes.key?(:'ip_version') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#default_backend_set_name ⇒ String

[Required] The name of the associated backend set.

Example: example_backend_set

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 41

def default_backend_set_name
  @default_backend_set_name
end

#ip_version ⇒ String

IP version associated with the listener.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 63

def ip_version
  @ip_version
end

#name ⇒ String

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

Example: example_listener

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 34

def name
  @name
end

#port ⇒ Integer

[Required] The communication port for the listener.

Example: 80

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 48

def port
  @port
end

#protocol ⇒ String

[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 operation.

Example: TCP

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 59

def protocol
  @protocol
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'default_backend_set_name': :'defaultBackendSetName',
    'port': :'port',
    'protocol': :'protocol',
    'ip_version': :'ipVersion'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'default_backend_set_name': :'String',
    'port': :'Integer',
    'protocol': :'String',
    'ip_version': :'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



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 162

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 &&
    ip_version == other.ip_version
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 196

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


176
177
178
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 176

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 185

def hash
  [name, default_backend_set_name, port, protocol, ip_version].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 229

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



223
224
225
 
# File 'lib/oci/network_load_balancer/models/listener_summary.rb', line 223

def to_s
  to_hash.to_s
end