Class: OCI::LoadBalancer::Models::Listener

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

Overview

The listener’s configuration. For more information on backend set configuration, see [Managing Load Balancer Listeners](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managinglisteners.htm).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Listener

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/load_balancer/models/listener.rb', line 106

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

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

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

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

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

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

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

  self.path_route_set_name = attributes[:'pathRouteSetName'] if attributes[:'pathRouteSetName']

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

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

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

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

  self.ssl_configuration = attributes[:'sslConfiguration'] if attributes[:'sslConfiguration']

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

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

Instance Attribute Details

#connection_configuration ⇒ OCI::LoadBalancer::Models::ConnectionConfiguration

Returns:



13
14
15
 
# File 'lib/oci/load_balancer/models/listener.rb', line 13

def connection_configuration
  @connection_configuration
end

#default_backend_set_name ⇒ String

[Required] The name of the associated backend set.

Example: ‘example_backend_set`

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/load_balancer/models/listener.rb', line 20

def default_backend_set_name
  @default_backend_set_name
end

#hostname_names ⇒ Array<String>

An array of hostname resource names.

Returns:

  • (Array<String>) 


24
25
26
 
# File 'lib/oci/load_balancer/models/listener.rb', line 24

def hostname_names
  @hostname_names
end

#name ⇒ String

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

Example: ‘example_listener`

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/load_balancer/models/listener.rb', line 31

def name
  @name
end

#path_route_set_name ⇒ String

The name of the set of path-based routing rules, PathRouteSet, applied to this listener’s traffic.

Example: ‘example_path_route_set`

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/load_balancer/models/listener.rb', line 39

def path_route_set_name
  @path_route_set_name
end

#port ⇒ Integer

[Required] The communication port for the listener.

Example: ‘80`

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/oci/load_balancer/models/listener.rb', line 46

def port
  @port
end

#protocol ⇒ String

[Required] The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the list_protocols operation.

Example: ‘HTTP`

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/load_balancer/models/listener.rb', line 55

def protocol
  @protocol
end

#ssl_configuration ⇒ OCI::LoadBalancer::Models::SSLConfiguration

Returns:



58
59
60
 
# File 'lib/oci/load_balancer/models/listener.rb', line 58

def ssl_configuration
  @ssl_configuration
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/load_balancer/models/listener.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_configuration': :'connectionConfiguration',
    'default_backend_set_name': :'defaultBackendSetName',
    'hostname_names': :'hostnameNames',
    'name': :'name',
    'path_route_set_name': :'pathRouteSetName',
    'port': :'port',
    'protocol': :'protocol',
    'ssl_configuration': :'sslConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/load_balancer/models/listener.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_configuration': :'OCI::LoadBalancer::Models::ConnectionConfiguration',
    'default_backend_set_name': :'String',
    'hostname_names': :'Array<String>',
    'name': :'String',
    'path_route_set_name': :'String',
    'port': :'Integer',
    'protocol': :'String',
    'ssl_configuration': :'OCI::LoadBalancer::Models::SSLConfiguration'
    # 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



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/load_balancer/models/listener.rb', line 156

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    connection_configuration == other.connection_configuration &&
    default_backend_set_name == other.default_backend_set_name &&
    hostname_names == other.hostname_names &&
    name == other.name &&
    path_route_set_name == other.path_route_set_name &&
    port == other.port &&
    protocol == other.protocol &&
    ssl_configuration == other.ssl_configuration
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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/load_balancer/models/listener.rb', line 192

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


172
173
174
 
# File 'lib/oci/load_balancer/models/listener.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/oci/load_balancer/models/listener.rb', line 181

def hash
  [connection_configuration, default_backend_set_name, hostname_names, name, path_route_set_name, port, protocol, ssl_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/load_balancer/models/listener.rb', line 224

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



218
219
220
 
# File 'lib/oci/load_balancer/models/listener.rb', line 218

def to_s
  to_hash.to_s
end